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`.`spread`.`publish``

module documentation
(source)

Persistently cached objects for PB.

Maintainer: Glyph Lefkowitz

Future Plans: None known.

Class | `Publishable` | An object whose cached state persists across sessions.
Class | `RemotePublished` | The local representation of remote Publishable object.
Function | `whenReady` | Wrap a deferred returned from a pb method in another deferred that expects a RemotePublished as a result. This will allow you to wait until the result is really available.
Function | `_pubReady` | (internal)

def whenReady(d): (source)

Wrap a deferred returned from a pb method in another deferred that expects a RemotePublished as a result. This will allow you to wait until the result is really available.

Idiomatic usage would look like:

        publish.whenReady(serverObject.getMeAPublishable()).addCallback(lookAtThePublishable)

def _pubReady(result, d2): (source)

(internal)