OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

Update comments and docstring

pull/6098/head
Richard van der Hoff 2019-09-25 18:17:39 +01:00
parent 4fb3c129aa
commit a96318127d
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
synapse/metrics/background_process_metrics.py
View File

@ -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):
_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)