Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`internet`.`defer`.`_ConcurrencyPrimitive``

class documentation

`class _ConcurrencyPrimitive(ABC): (source)`

Known subclasses: `twisted.internet.defer.DeferredLock`, `twisted.internet.defer.DeferredSemaphore`

View In Hierarchy

Undocumented

Method | `__aenter__` | We can be used as an asynchronous context manager.
Method | `__aexit__` | Undocumented
Method | `__init__` | Undocumented
Method | `acquire` | Undocumented
Method | `release` | Undocumented
Method | `run` | Acquire, run, release.
Instance Variable | `waiting` | Undocumented
Method | `_releaseAndReturn` | Undocumented

def __aenter__(self: `Self`) -> `Deferred[Self]`: (source)

We can be used as an asynchronous context manager.

def __aexit__(self, __exc_type: `Optional[Type[BaseException]]`, __exc_value: `Optional[BaseException]`, __traceback: `Optional[TracebackType]`) -> `Deferred[Literal[False]]`: (source)

Undocumented

def __init__(self: `Self`): (source)
overridden in `twisted.internet.defer.DeferredSemaphore`

Undocumented

@abstractmethod
def acquire(self: `Self`) -> `Deferred[Self]`: (source)
overridden in `twisted.internet.defer.DeferredLock`, `twisted.internet.defer.DeferredSemaphore`

Undocumented

@abstractmethod
def release(self): (source)
overridden in `twisted.internet.defer.DeferredLock`, `twisted.internet.defer.DeferredSemaphore`

Undocumented

@overload
def run(self: `Self`, /, f: `Callable[_P, Deferred[_T]]`, *args: `_P.args`, **kwargs: `_P.kwargs`) -> `Deferred[_T]`:
@overload
def run(self: `Self`, /, f: `Callable[_P, Coroutine[Deferred[Any], Any, _T]]`, *args: `_P.args`, **kwargs: `_P.kwargs`) -> `Deferred[_T]`:
@overload
def run(self: `Self`, /, f: `Callable[_P, _T]`, *args: `_P.args`, **kwargs: `_P.kwargs`) -> `Deferred[_T]`:
(source)

Acquire, run, release.

This method takes a callable as its first argument and any number of other positional and keyword arguments. When the lock or semaphore is acquired, the callable will be invoked with those arguments.

The callable may return a `Deferred`; if it does, the lock or semaphore won't be released until that `Deferred` fires.

Returns
`Deferred[_T]` | `Deferred` of function result.

waiting: `List[Deferred[Self]]` = (source)

Undocumented

def _releaseAndReturn(self, r: `_T`) -> `_T`: (source)

Undocumented