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`.`deprecate`.`_DeprecatedAttribute``

class documentation

`class _DeprecatedAttribute: (source)`

Constructor: `_DeprecatedAttribute(module, name, version, message)`

View In Hierarchy

Wrapper for deprecated attributes.

This is intended to be used by `_ModuleProxy`. Calling `_DeprecatedAttribute.get` will issue a warning and retrieve the underlying attribute's value.

Method | `__init__` | Initialise a deprecated name wrapper.
Method | `get` | Get the underlying attribute value and issue a deprecation warning.
Instance Variable | `__name__` | Undocumented
Instance Variable | `fqpn` | Fully qualified Python name for the deprecated attribute
Instance Variable | `message` | Deprecation message
Instance Variable | `module` | The original module instance containing this attribute
Instance Variable | `version` | Version that the attribute was deprecated in

def __init__(self, module, name, version, message): (source)

Initialise a deprecated name wrapper.

def get(self): (source)

Get the underlying attribute value and issue a deprecation warning.

__name__ = (source)

Undocumented

fqpn: `str` = (source)

Fully qualified Python name for the deprecated attribute

message: `str` = (source)

Deprecation message

module: `module` = (source)

The original module instance containing this attribute

version: `incremental.Version` = (source)

Version that the attribute was deprecated in