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`.`words`.`protocols`.`jabber`.`xmpp_stringprep`.`Profile``

class documentation

`class Profile: (source)`

Constructor: `Profile(mappings, normalize, prohibiteds, check_unassigneds, check_bidi)`

View In Hierarchy

Undocumented

Method | `__init__` | Undocumented
Method | `check_bidirectionals` | Undocumented
Method | `check_prohibiteds` | Undocumented
Method | `check_unassigneds` | Undocumented
Method | `map` | Undocumented
Method | `prepare` | Undocumented
Instance Variable | `do_check_bidi` | Undocumented
Instance Variable | `do_check_unassigneds` | Undocumented
Instance Variable | `mappings` | Undocumented
Instance Variable | `normalize` | Undocumented
Instance Variable | `prohibiteds` | Undocumented

def __init__(self, mappings=[], normalize=True, prohibiteds=[], check_unassigneds=True, check_bidi=True): (source)

Undocumented

def check_bidirectionals(self, string): (source)

Undocumented

def check_prohibiteds(self, string): (source)

Undocumented

def check_unassigneds(self, string): (source)

Undocumented

def map(self, string): (source)

Undocumented

def prepare(self, string): (source)

Undocumented

do_check_bidi = (source)

Undocumented

do_check_unassigneds = (source)

Undocumented

mappings = (source)

Undocumented

normalize = (source)

Undocumented

prohibiteds = (source)

Undocumented