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`.`pb`.`Serializable``

class documentation

`class Serializable(Jellyable): (source)`

Known subclasses: `twisted.spread.pb.Copyable`, `twisted.spread.pb.Referenceable`, `twisted.spread.pb.RemoteCache`, `twisted.spread.pb.RemoteReference`, `twisted.spread.pb.Viewable`

View In Hierarchy

An object that can be passed remotely.

I am a style of object which can be serialized by Perspective Broker. Objects which wish to be referenceable or copied remotely have to subclass Serializable. However, clients of Perspective Broker will probably not want to directly subclass Serializable; the Flavors of transferable objects are listed below.

What it means to be "Serializable" is that an object can be passed to or returned from a remote method. Certain basic types (dictionaries, lists, tuples, numbers, strings) are serializable by default; however, classes need to choose a specific serialization style: `Referenceable`, `Viewable`, `Copyable` or `Cacheable`.

You may also pass `[lists, dictionaries, tuples]` of `Serializable` instances to or return them from remote methods, as many levels deep as you like.

Method | `processUniqueID` | Return an ID which uniquely represents this object for this process.

Inherited from `Jellyable`:

Method | `getStateFor` | Undocumented
Method | `jellyFor` | No summary

def processUniqueID(self): (source)
overridden in `twisted.spread.pb.ViewPoint`, `twisted.words.service.PBGroup`, `twisted.words.service.PBUser`

Return an ID which uniquely represents this object for this process.

By default, this uses the 'id' builtin, but can be overridden to indicate that two values are identity-equivalent (such as proxies for the same object).