Skip to content
Snippets Groups Projects
Commit a9631812 authored by Richard van der Hoff's avatar Richard van der Hoff
Browse files

Update comments and docstring

parent 4fb3c129
No related branches found
No related tags found
No related merge requests found
...@@ -175,7 +175,7 @@ def run_as_background_process(desc, func, *args, **kwargs): ...@@ -175,7 +175,7 @@ def run_as_background_process(desc, func, *args, **kwargs):
Args: Args:
desc (str): a description for this background process type desc (str): a description for this background process type
func: a function, which may return a Deferred func: a function, which may return a Deferred or a coroutine
args: positional args for func args: positional args for func
kwargs: keyword args for func kwargs: keyword args for func
...@@ -199,11 +199,13 @@ def run_as_background_process(desc, func, *args, **kwargs): ...@@ -199,11 +199,13 @@ def run_as_background_process(desc, func, *args, **kwargs):
_background_processes.setdefault(desc, set()).add(proc) _background_processes.setdefault(desc, set()).add(proc)
try: try:
# We ensureDeferred here to handle coroutines
result = func(*args, **kwargs) result = func(*args, **kwargs)
# We need this check because ensureDeferred doesn't like when # We probably don't have an ensureDeferred in our call stack to handle
# func doesn't return a Deferred or coroutine. # coroutine results, so we need to ensureDeferred here.
#
# But we need this check because ensureDeferred doesn't like being
# called on immediate values (as opposed to Deferreds or coroutines).
if iscoroutine(result): if iscoroutine(result):
result = defer.ensureDeferred(result) result = defer.ensureDeferred(result)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment