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`.`Avatar``

class documentation

`class Avatar: (source)`

Implements interfaces: `twisted.spread.pb.IPerspective`

View In Hierarchy

A default IPerspective implementor.

This class is intended to be subclassed, and a realm should return an instance of such a subclass when IPerspective is requested of it.

A peer requesting a perspective will receive only a `RemoteReference` to a pb.Avatar. When a method is called on that `RemoteReference`, it will translate to a method on the remote perspective named 'perspective_methodname'. (For more information on invoking methods on other objects, see `flavors.ViewPoint`.)

Method | `perspectiveMessageReceived` | This method is called when a network message is received.

def perspectiveMessageReceived(self, broker, message, args, kw): (source)
from `twisted.spread.pb.IPerspective`

This method is called when a network message is received.

This will call:

        self.perspective_%(message)s(*broker.unserialize(args),
                                     **broker.unserialize(kw))

to handle the method; subclasses of Avatar are expected to implement methods using this naming convention.