Package pyxmpp2 :: Module interfaces :: Class StanzaPayload
[hide private]

Class StanzaPayload


Abstract base class for stanza payload objects.

Subclasses are used to encapsulate stanza payload data and to reference payload type in stanza handlers or when requesting particular payload from a stanza.

Nested Classes [hide private]
  __metaclass__
Metaclass for defining Abstract Base Classes (ABCs).
Instance Methods [hide private]
ElementTree.Element
as_xml(self)
Return the XML representation of the payload.
 
copy(self)
Return a deep copy of self.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods [hide private]
 
from_xml(cls, element)
Create a cls instance from an XML element.
Class Variables [hide private]
  __abstractmethods__ = frozenset(['as_xml'])
  _abc_cache = <_weakrefset.WeakSet object at 0x86cc12c>
  _abc_negative_cache = <_weakrefset.WeakSet object at 0x86cc16c>
  _abc_negative_cache_version = 10
  _abc_registry = <_weakrefset.WeakSet object at 0x86cc0cc>
Properties [hide private]
  handler_key
Defines a key which may be used when registering handlers for stanzas with this payload.

Inherited from object: __class__

Method Details [hide private]

from_xml(cls, element)
Class Method

 
Create a cls instance from an XML element.
Parameters:
Decorators:
  • @abstractclassmethod

as_xml(self)

 
Return the XML representation of the payload.
Returns: ElementTree.Element
Decorators:
  • @abstractmethod

Property Details [hide private]

handler_key

Defines a key which may be used when registering handlers for stanzas with this payload.
Get Method:
unreachable.handler_key(self) - Defines a key which may be used when registering handlers for stanzas with this payload.