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`.`internet`.`ssl`.`DistinguishedName``

class documentation

`class DistinguishedName(Dict[str, bytes]): (source)`

Constructor: `DistinguishedName(**kw)`

View In Hierarchy

Identify and describe an entity.

Distinguished names are used to provide a minimal amount of identifying information about a certificate issuer or subject. They are commonly created with one or more of the following fields:

        commonName (CN)
        organizationName (O)
        organizationalUnitName (OU)
        localityName (L)
        stateOrProvinceName (ST)
        countryName (C)
        emailAddress

A `DistinguishedName` should be constructed using keyword arguments whose keys can be any of the field names above (as a native string), and the values are either Unicode text which is encodable to ASCII, or `bytes` limited to the ASCII subset. Any fields passed to the constructor will be set as attributes, accessible using both their extended name and their shortened acronym. The attribute values will be the ASCII-encoded bytes. For example:

        >>> dn = DistinguishedName(commonName=b'www.example.com',
        ...                        C='US')
        >>> dn.C
        b'US'
        >>> dn.countryName
        b'US'
        >>> hasattr(dn, "organizationName")
        False

`DistinguishedName` instances can also be used as dictionaries; the keys are extended name of the fields:

        >>> dn.keys()
        ['countryName', 'commonName']
        >>> dn['countryName']
        b'US'

Method | `__getattr__` | Undocumented
Method | `__init__` | Undocumented
Method | `__repr__` | Undocumented
Method | `__setattr__` | Undocumented
Method | `inspect` | Return a multi-line, human-readable representation of this DN.
Class Variable | `__slots__` | Undocumented
Method | `_copyFrom` | Undocumented
Method | `_copyInto` | Undocumented

def __getattr__(self, attr): (source)

Undocumented

def __init__(self, **kw): (source)

Undocumented

def __repr__(self) -> `str`: (source)

Undocumented

def __setattr__(self, attr, value): (source)

Undocumented

def inspect(self): (source)

Return a multi-line, human-readable representation of this DN.

Returns
`str` | Undocumented

__slots__: `tuple` = (source)

Undocumented

def _copyFrom(self, x509name): (source)

Undocumented

def _copyInto(self, x509name): (source)

Undocumented