t.w.p.j.jid : module documentation

Part of twisted.words.protocols.jabber View 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.

def parse(jidstring): (source)

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

Parameters	jidstring	string representation of a JID. (type: `unicode`)
Returns	tuple of (user, host, resource), each of type `unicode` 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.

Parameters	user	The user part of the JID. (type: `unicode`)
	host	The host part of the JID. (type: `unicode`)
	resource	The resource part of the JID. (type: `unicode`)
Returns	The given parts with stringprep applied. (type: `tuple`)

def internJID(jidstring): (source)

Return interned JID.

Returns (type: JID)

API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.