Skip to content

Make extract_result() and DeferredNotFired public APIs #562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jelmer merged 1 commit into from
Jan 28, 2026
Merged

Make extract_result() and DeferredNotFired public APIs #562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions NEWS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,17 @@ testtools NEWS

Changes and improvements to testtools_, grouped by release.

NEXT
~~~~

Improvements
------------

* Make ``extract_result()`` and ``DeferredNotFired`` public APIs in
``testtools.twistedsupport``. These utilities are useful for extracting
results from synchronous Deferreds in tests.
(Jelmer Vernooij, #546)

2.8.3
~~~~~

Expand Down
14 changes: 14 additions & 0 deletions doc/twisted-support.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,20 @@ See also `Testing Deferreds without the reactor`_ and the `Deferred howto`_.
:noindex:


Extracting results from Deferreds
----------------------------------

When testing code that returns synchronous
:py:class:`~twisted.internet.defer.Deferred`\s for compatibility reasons, you
may want to extract the result directly instead of using matchers.

.. autofunction:: testtools.twistedsupport.extract_result
:noindex:

.. autoexception:: testtools.twistedsupport.DeferredNotFired
:noindex:


Running tests in the reactor
----------------------------

Expand Down
7 changes: 7 additions & 0 deletions testtools/twistedsupport/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,22 @@
"AsynchronousDeferredRunTest",
"AsynchronousDeferredRunTestForBrokenTwisted",
"CaptureTwistedLogs",
# Deferred utilities
"DeferredNotFired",
"SynchronousDeferredRunTest",
"assert_fails_with",
"extract_result",
"failed",
"flush_logged_errors",
"has_no_result",
# Matchers
"succeeded",
]

from ._deferred import (
DeferredNotFired,
extract_result,
)
from ._matchers import (
failed,
has_no_result,
Expand Down