twisted.words.protocols.jabber.jid

module documentation
(source)

Jabber Identifier support.

This module provides an object to represent Jabber Identifiers (JIDs) and parse string representations into them with proper checking for illegal characters, case folding and canonicalisation through stringprep.

Class InvalidFormat The given string could not be parsed into a valid Jabber Identifier (JID).
Function parse Parse given JID string into its respective parts and apply stringprep.
Function prep Perform stringprep on all JID fragments.
Function internJID Return interned JID.
Class JID Represents a stringprep'd Jabber ID.
Variable __internJIDs Undocumented
def parse(jidstring): (source)

Parse given JID string into its respective parts and apply stringprep.

Parametersjidstringstring representation of a JID. (type: str)
Returnstuple of (user, host, resource), each of type str as the parsed and stringprep'd parts of the given JID. If the given string did not have a user or resource part, the respective field in the tuple will hold None. (type: tuple)
def prep(user, host, resource): (source)

Perform stringprep on all JID fragments.

ParametersuserThe user part of the JID. (type: str)
hostThe host part of the JID. (type: str)
resourceThe resource part of the JID. (type: str)
ReturnsThe given parts with stringprep applied. (type: tuple)
__internJIDs = (source)

Undocumented

(type: Dict[str, JID])
def internJID(jidstring): (source)

Return interned JID.

ReturnsUndocumented (type: JID)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.