t.w.p.j.j.JID(object) : class documentation

Part of twisted.words.protocols.jabber.jid View Source View In Hierarchy

Represents a stringprep'd Jabber ID.

JID objects are hashable so they can be used in sets and as keys in dictionaries.

Method	__init__	Undocumented
Method	userhost	Extract the bare JID as a unicode string.
Method	userhostJID	Extract the bare JID.
Method	full	Return the string representation of this JID.
Method	__eq__	Equality comparison.
Method	__ne__	Inequality comparison.
Method	__hash__	Calculate hash.
Method	__unicode__	Get unicode representation.
Method	__repr__	Get object representation.

def __init__(self, str=None, tuple=None): (source)

Undocumented

def userhost(self): (source)

Extract the bare JID as a unicode string.

A bare JID does not have a resource part, so this returns either user@host or just host.

Returns (type: unicode)

def userhostJID(self): (source)

Extract the bare JID.

A bare JID does not have a resource part, so this returns a JID object representing either user@host or just host.

If the object this method is called upon doesn't have a resource set, it will return itself. Otherwise, the bare JID object will be created, interned using internJID.

Returns (type: JID)

def full(self): (source)

Return the string representation of this JID.

Returns (type: unicode)

def __eq__(self, other): (source)

Equality comparison.

JIDs compare equal if their user, host and resource parts all compare equal. When comparing against instances of other types, it uses the default comparison.

def __ne__(self, other): (source)

Inequality comparison.

This negates __eq__ for comparison with JIDs and uses the default comparison for other types.

def __hash__(self): (source)

Calculate hash.

JIDs with identical constituent user, host and resource parts have equal hash values. In combination with the comparison defined on JIDs, this allows for using JIDs in sets and as dictionary keys.

def __unicode__(self): (source)

Get unicode representation.

Return the string representation of this JID as a unicode string.