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`.`python`.`components`.`_ProxyDescriptor``

class documentation

`class _ProxyDescriptor: (source)`

View In Hierarchy

A descriptor which will proxy attribute access, mutation, and deletion to the `_ProxyDescriptor.originalAttribute` of the object it is being accessed from.

Method | `__delete__` | Delete the `self.attributeName` property of oself.
Method | `__get__` | Retrieve the `self.attributeName` property from oself.
Method | `__init__` | Undocumented
Method | `__set__` | Set the `self.attributeName` property of oself.
Instance Variable | `attributeName` | the name of the attribute which this descriptor will retrieve from instances' `original` attribute.
Instance Variable | `originalAttribute` | name of the attribute of the proxy where the original object is stored.

def __delete__(self, oself): (source)

Delete the `self.attributeName` property of oself.

def __get__(self, oself, type=None): (source)

Retrieve the `self.attributeName` property from oself.

def __init__(self, attributeName, originalAttribute): (source)

Undocumented

def __set__(self, oself, value): (source)

Set the `self.attributeName` property of oself.

attributeName: `str` = (source)

the name of the attribute which this descriptor will retrieve from instances' `original` attribute.

originalAttribute: `str` = (source)

name of the attribute of the proxy where the original object is stored.