Replaces async occurrences with alternatives

* async is now a reserved word in python3.7
 * Rename async function to enqueue
 * Rename all async_ functions to enqueue_
 * Rename Async class to AsyncTask
 * Updates the docs.

django_q/tests/test_cached.py

@@ -5,8 +5,8 @@ import pytest
 from django_q.cluster import pusher, worker, monitor
 from django_q.compat import range
 from django_q.conf import Conf
-from django_q.tasks import async, result, fetch, count_group, result_group, fetch_group, delete_group, delete_cached, \
-    async_iter, Chain, async_chain, Iter, Async
+from django_q.tasks import enqueue, result, fetch, count_group, result_group, fetch_group, delete_group, delete_cached, \
+    enqueue_iter, Chain, enqueue_chain, Iter, AsyncTask
 from django_q.brokers import get_broker
 from django_q.queues import Queue
 
@@ -23,14 +23,14 @@ def test_cached(broker):
     broker.cache.clear()
     group = 'cache_test'
     # queue the tests
-    task_id = async('math.copysign', 1, -1, cached=True, broker=broker)
-    async('math.copysign', 1, -1, cached=True, broker=broker, group=group)
-    async('math.copysign', 1, -1, cached=True, broker=broker, group=group)
-    async('math.copysign', 1, -1, cached=True, broker=broker, group=group)
-    async('math.copysign', 1, -1, cached=True, broker=broker, group=group)
-    async('math.copysign', 1, -1, cached=True, broker=broker, group=group)
-    async('math.popysign', 1, -1, cached=True, broker=broker, group=group)
-    iter_id = async_iter('math.floor', [i for i in range(10)], cached=True)
+    task_id = enqueue('math.copysign', 1, -1, cached=True, broker=broker)
+    enqueue('math.copysign', 1, -1, cached=True, broker=broker, group=group)
+    enqueue('math.copysign', 1, -1, cached=True, broker=broker, group=group)
+    enqueue('math.copysign', 1, -1, cached=True, broker=broker, group=group)
+    enqueue('math.copysign', 1, -1, cached=True, broker=broker, group=group)
+    enqueue('math.copysign', 1, -1, cached=True, broker=broker, group=group)
+    enqueue('math.popysign', 1, -1, cached=True, broker=broker, group=group)
+    iter_id = enqueue_iter('math.floor', [i for i in range(10)], cached=True)
     # test wait on cache
     # test wait timeout
     assert result(task_id, wait=10, cached=True) is None
@@ -86,10 +86,10 @@ def test_iter(broker):
     it = [i for i in range(10)]
     it2 = [(1, -1), (2, -1), (3, -4), (5, 6)]
     it3 = (1, 2, 3, 4, 5)
-    t = async_iter('math.floor', it, sync=True)
-    t2 = async_iter('math.copysign', it2, sync=True)
-    t3 = async_iter('math.floor', it3, sync=True)
-    t4 = async_iter('math.floor', (1,), sync=True)
+    t = enqueue_iter('math.floor', it, sync=True)
+    t2 = enqueue_iter('math.copysign', it2, sync=True)
+    t3 = enqueue_iter('math.floor', it3, sync=True)
+    t4 = enqueue_iter('math.floor', (1,), sync=True)
     result_t = result(t)
     assert result_t is not None
     task_t = fetch(t)
@@ -140,15 +140,15 @@ def test_chain(broker):
     t = task_chain.fetch()
     assert len(t) == task_chain.length()
     # test single
-    rid = async_chain(['django_q.tests.tasks.hello', 'django_q.tests.tasks.hello'], sync=True, cached=True)
+    rid = enqueue_chain(['django_q.tests.tasks.hello', 'django_q.tests.tasks.hello'], sync=True, cached=True)
     assert result_group(rid, cached=True) == ['hello', 'hello']
 
 
 @pytest.mark.django_db
-def test_async_class(broker, monkeypatch):
+def test_asynctask_class(broker, monkeypatch):
     broker.purge_queue()
     broker.cache.clear()
-    a = Async('math.copysign')
+    a = AsyncTask('math.copysign')
     assert a.func == 'math.copysign'
     a.args = (1, -1)
     assert a.started is False
@@ -162,11 +162,11 @@ def test_async_class(broker, monkeypatch):
     assert a.result() == -1
     assert a.fetch().result == -1
     # again with kwargs
-    a = Async('math.copysign', 1, -1, cached=True, sync=True, broker=broker)
+    a = AsyncTask('math.copysign', 1, -1, cached=True, sync=True, broker=broker)
     a.run()
     assert a.result() == -1
     # with q_options
-    a = Async('math.copysign', 1, -1, q_options={'cached': True, 'sync': False, 'broker': broker})
+    a = AsyncTask('math.copysign', 1, -1, q_options={'cached': True, 'sync': False, 'broker': broker})
     assert a.sync is False
     a.sync = True
     assert a.kwargs['q_options']['sync'] is True
@@ -185,6 +185,6 @@ def test_async_class(broker, monkeypatch):
     # global overrides
     monkeypatch.setattr(Conf, 'SYNC', True)
     monkeypatch.setattr(Conf, 'CACHED', True)
-    a = Async('math.floor', 1.5)
+    a = AsyncTask('math.floor', 1.5)
     a.run()
     assert a.result() == 1

django_q/tests/test_cluster.py

@@ -13,7 +13,7 @@ sys.path.insert(0, myPath + '/../')
 from django_q.cluster import Cluster, Sentinel, pusher, worker, monitor, save_task
 from django_q.compat import range
 from django_q.humanhash import DEFAULT_WORDLIST, uuid
-from django_q.tasks import fetch, fetch_group, async, result, result_group, count_group, delete_group, queue_size
+from django_q.tasks import fetch, fetch_group, enqueue, result, result_group, count_group, delete_group, queue_size
 from django_q.models import Task, Success
 from django_q.conf import Conf
 from django_q.status import Stat
@@ -42,7 +42,7 @@ def test_redis_connection(broker):
 
 @pytest.mark.django_db
 def test_sync(broker):
-    task = async('django_q.tests.tasks.count_letters', DEFAULT_WORDLIST, broker=broker, sync=True)
+    task = enqueue('django_q.tests.tasks.count_letters', DEFAULT_WORDLIST, broker=broker, sync=True)
     assert result(task) == 1506
 
 
@@ -82,7 +82,7 @@ def test_sentinel():
 def test_cluster(broker):
     broker.list_key = 'cluster_test:q'
     broker.delete_queue()
-    task = async('django_q.tests.tasks.count_letters', DEFAULT_WORDLIST, broker=broker)
+    task = enqueue('django_q.tests.tasks.count_letters', DEFAULT_WORDLIST, broker=broker)
     assert broker.queue_size() == 1
     task_queue = Queue()
     assert task_queue.qsize() == 0
@@ -109,32 +109,32 @@ def test_cluster(broker):
 
 
 @pytest.mark.django_db
-def test_async(broker, admin_user):
+def test_enqueue(broker, admin_user):
     broker.list_key = 'cluster_test:q'
     broker.delete_queue()
-    a = async('django_q.tests.tasks.count_letters', DEFAULT_WORDLIST, hook='django_q.tests.test_cluster.assert_result',
-              broker=broker)
-    b = async('django_q.tests.tasks.count_letters2', WordClass(), hook='django_q.tests.test_cluster.assert_result',
-              broker=broker)
+    a = enqueue('django_q.tests.tasks.count_letters', DEFAULT_WORDLIST, hook='django_q.tests.test_cluster.assert_result',
+                broker=broker)
+    b = enqueue('django_q.tests.tasks.count_letters2', WordClass(), hook='django_q.tests.test_cluster.assert_result',
+                broker=broker)
     # unknown argument
-    c = async('django_q.tests.tasks.count_letters', DEFAULT_WORDLIST, 'oneargumentoomany',
-              hook='django_q.tests.test_cluster.assert_bad_result', broker=broker)
+    c = enqueue('django_q.tests.tasks.count_letters', DEFAULT_WORDLIST, 'oneargumentoomany',
+                hook='django_q.tests.test_cluster.assert_bad_result', broker=broker)
     # unknown function
-    d = async('django_q.tests.tasks.does_not_exist', WordClass(), hook='django_q.tests.test_cluster.assert_bad_result',
-              broker=broker)
+    d = enqueue('django_q.tests.tasks.does_not_exist', WordClass(), hook='django_q.tests.test_cluster.assert_bad_result',
+                broker=broker)
     # function without result
-    e = async('django_q.tests.tasks.countdown', 100000, broker=broker)
+    e = enqueue('django_q.tests.tasks.countdown', 100000, broker=broker)
     # function as instance
-    f = async(multiply, 753, 2, hook=assert_result, broker=broker)
+    f = enqueue(multiply, 753, 2, hook=assert_result, broker=broker)
     # model as argument
-    g = async('django_q.tests.tasks.get_task_name', Task(name='John'), broker=broker)
+    g = enqueue('django_q.tests.tasks.get_task_name', Task(name='John'), broker=broker)
     # args,kwargs, group and broken hook
-    h = async('django_q.tests.tasks.word_multiply', 2, word='django', hook='fail.me', broker=broker)
+    h = enqueue('django_q.tests.tasks.word_multiply', 2, word='django', hook='fail.me', broker=broker)
     # args unpickle test
-    j = async('django_q.tests.tasks.get_user_id', admin_user, broker=broker, group='test_j')
+    j = enqueue('django_q.tests.tasks.get_user_id', admin_user, broker=broker, group='test_j')
     # q_options and save opt_out test
-    k = async('django_q.tests.tasks.get_user_id', admin_user,
-              q_options={'broker': broker, 'group': 'test_k', 'save': False, 'timeout': 90})
+    k = enqueue('django_q.tests.tasks.get_user_id', admin_user,
+                q_options={'broker': broker, 'group': 'test_k', 'save': False, 'timeout': 90})
     # check if everything has a task id
     assert isinstance(a, str)
     assert isinstance(b, str)
@@ -249,7 +249,7 @@ def test_timeout(broker):
     # set up the Sentinel
     broker.list_key = 'timeout_test:q'
     broker.purge_queue()
-    async('django_q.tests.tasks.count_forever', broker=broker)
+    enqueue('django_q.tests.tasks.count_forever', broker=broker)
     start_event = Event()
     stop_event = Event()
     # Set a timer to stop the Sentinel
@@ -265,7 +265,7 @@ def test_timeout(broker):
 def test_timeout_override(broker):
     # set up the Sentinel
     broker.list_key = 'timeout_override_test:q'
-    async('django_q.tests.tasks.count_forever', broker=broker, timeout=1)
+    enqueue('django_q.tests.tasks.count_forever', broker=broker, timeout=1)
     start_event = Event()
     stop_event = Event()
     # Set a timer to stop the Sentinel
@@ -281,9 +281,9 @@ def test_timeout_override(broker):
 def test_recycle(broker, monkeypatch):
     # set up the Sentinel
     broker.list_key = 'test_recycle_test:q'
-    async('django_q.tests.tasks.multiply', 2, 2, broker=broker)
-    async('django_q.tests.tasks.multiply', 2, 2, broker=broker)
-    async('django_q.tests.tasks.multiply', 2, 2, broker=broker)
+    enqueue('django_q.tests.tasks.multiply', 2, 2, broker=broker)
+    enqueue('django_q.tests.tasks.multiply', 2, 2, broker=broker)
+    enqueue('django_q.tests.tasks.multiply', 2, 2, broker=broker)
     start_event = Event()
     stop_event = Event()
     # override settings
@@ -295,8 +295,8 @@ def test_recycle(broker, monkeypatch):
     assert start_event.is_set()
     assert s.status() == Conf.STOPPED
     assert s.reincarnations == 1
-    async('django_q.tests.tasks.multiply', 2, 2, broker=broker)
-    async('django_q.tests.tasks.multiply', 2, 2, broker=broker)
+    enqueue('django_q.tests.tasks.multiply', 2, 2, broker=broker)
+    enqueue('django_q.tests.tasks.multiply', 2, 2, broker=broker)
     task_queue = Queue()
     result_queue = Queue()
     # push two tasks
@@ -318,7 +318,7 @@ def test_recycle(broker, monkeypatch):
 @pytest.mark.django_db
 def test_bad_secret(broker, monkeypatch):
     broker.list_key = 'test_bad_secret:q'
-    async('math.copysign', 1, -1, broker=broker)
+    enqueue('math.copysign', 1, -1, broker=broker)
     stop_event = Event()
     stop_event.set()
     start_event = Event()

django_q/tests/test_monitor.py

@@ -1,6 +1,6 @@
 import pytest
 
-from django_q.tasks import async
+from django_q.tasks import enqueue
 from django_q.brokers import get_broker
 from django_q.cluster import Cluster
 from django_q.compat import range
@@ -46,4 +46,4 @@ def test_info():
 
 
 def do_sync():
-    async('django_q.tests.tasks.countdown', 1, sync=True, save=True)
+    enqueue('django_q.tests.tasks.countdown', 1, sync=True, save=True)