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.
This commit is contained in:
Pierre-Elliott Bécue
2018-07-07 21:33:43 +02:00
parent 2040771e80
commit ae75a84f7f
16 changed files with 190 additions and 190 deletions
+13 -13
View File
@@ -17,7 +17,7 @@ from django_q.signals import pre_enqueue
from django_q.queues import Queue
def async(func, *args, **kwargs):
def enqueue(func, *args, **kwargs):
"""Queue a task for the cluster."""
keywords = kwargs.copy()
opt_keys = ('hook', 'group', 'save', 'sync', 'cached', 'ack_failure', 'iter_count', 'iter_cached', 'chain', 'broker')
@@ -390,9 +390,9 @@ def queue_size(broker=None):
return broker.queue_size()
def async_iter(func, args_iter, **kwargs):
def enqueue_iter(func, args_iter, **kwargs):
"""
async a function with iterable arguments
enqueues a function with iterable arguments
"""
iter_count = len(args_iter)
iter_group = uuid()[1]
@@ -411,13 +411,13 @@ def async_iter(func, args_iter, **kwargs):
for args in args_iter:
if type(args) is not tuple:
args = (args,)
async(func, *args, **options)
enqueue(func, *args, **options)
return iter_group
def async_chain(chain, group=None, cached=Conf.CACHED, sync=Conf.SYNC, broker=None):
def enqueue_chain(chain, group=None, cached=Conf.CACHED, sync=Conf.SYNC, broker=None):
"""
async a chain of tasks
enqueues a chain of tasks
the chain must be in the format [(func,(args),{kwargs}),(func,(args),{kwargs})]
"""
if not group:
@@ -436,7 +436,7 @@ def async_chain(chain, group=None, cached=Conf.CACHED, sync=Conf.SYNC, broker=No
kwargs['cached'] = cached
kwargs['sync'] = sync
kwargs['broker'] = broker or get_broker()
async(task[0], *args, **kwargs)
enqueue(task[0], *args, **kwargs)
return group
@@ -472,7 +472,7 @@ class Iter(object):
self.kwargs['cached'] = self.cached
self.kwargs['sync'] = self.sync
self.kwargs['broker'] = self.broker
self.id = async_iter(self.func, self.args, **self.kwargs)
self.id = enqueue_iter(self.func, self.args, **self.kwargs)
self.started = True
return self.id
@@ -518,7 +518,7 @@ class Chain(object):
def append(self, func, *args, **kwargs):
"""
add a task to the chain
takes the same parameters as async()
takes the same parameters as enqueue()
"""
self.chain.append((func, args, kwargs))
# remove existing results
@@ -532,8 +532,8 @@ class Chain(object):
Start queueing the chain to the worker cluster
:return: the chain's group id
"""
self.group = async_chain(chain=self.chain[:], group=self.group, cached=self.cached, sync=self.sync,
broker=self.broker)
self.group = enqueue_chain(chain=self.chain[:], group=self.group, cached=self.cached, sync=self.sync,
broker=self.broker)
self.started = True
return self.group
@@ -573,7 +573,7 @@ class Chain(object):
return len(self.chain)
class Async(object):
class AsyncTask(object):
"""
an async task
"""
@@ -647,7 +647,7 @@ class Async(object):
return self.kwargs.get(key, default)
def run(self):
self.id = async(self.func, *self.args, **self.kwargs)
self.id = enqueue(self.func, *self.args, **self.kwargs)
self.started = True
return self.id