ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2025-04-19 00:06:57 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Expand docs

Browse Source
This commit is contained in:
Itamar Turner-Trauring 2023-10-19 11:15:06 -04:00
parent bab97cf319
commit 303e45b1e5
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/allmydata/util/cputhreadpool.py
View File

@ -54,7 +54,12 @@ _DISABLED = False
def defer_to_thread(
f: Callable[P, R], *args: P.args, **kwargs: P.kwargs
) -> Deferred[R]:
"""Run the function in a thread, return the result as a ``Deferred``."""
"""
Run the function in a thread, return the result as a ``Deferred``.
However, if ``disable_thread_pool_for_test()`` was called the function will
be called synchronously inside the current thread.
"""
if _DISABLED:
return maybeDeferred(f, *args, **kwargs)
@ -65,8 +70,8 @@ def defer_to_thread(
def disable_thread_pool_for_test(test: TestCase) -> None:
"""
For the duration of the test, calls to C{defer_to_thread} will actually run
synchronously.
For the duration of the test, calls to ``defer_to_thread()`` will actually
run synchronously, which is useful for synchronous unit tests.
"""
global _DISABLED