mirror of
https://github.com/correl/SleekXMPP.git
synced 2024-11-24 03:00:15 +00:00
Python 2.6+/3.1+ XMPP Library
6d45971411
Each interface, say foo, may be overridden in three ways:
set_foo
get_foo
del_foo
To declare an override in a plugin, add the class field
overrides as so:
overrides = ['set_foo', 'del_foo']
Each override must have a matching set_foo(), etc method
for implementing the new behaviour.
To enable the overrides for a particular parent stanza,
pass the option overrides=True to register_stanza_plugin.
register_stanza_plugin(Stanza, Plugin, overrides=True)
Example code:
class Test(ElementBase):
name = 'test'
namespace = 'testing'
interfaces = set(('foo', 'bar'))
sub_interfaces = set(('bar',))
class TestOverride(ElementBase):
name = 'test-override'
namespace = 'testing'
plugin_attrib = 'override'
interfaces = set(('foo',))
overrides = ['set_foo']
def setup(self, xml):
# Don't include an XML element in the parent stanza
# since we're adding just an attribute.
# If adding a regular subelement, no need to do this.
self.xml = ET.Element('')
def set_foo(self, value):
print("overrides!")
self.parent()._set_attr('foo', 'override-%s' % value)
register_stanza_plugin(Test, TestOverride, overrides=True)
Example usage:
>>> t = TestStanza()
>>> t['foo'] = 'bar'
>>> t['foo']
'override-bar'
|
||
|---|---|---|
| conn_tests | ||
| examples | ||
| sleekxmpp | ||
| tests | ||
| .gitignore | ||
| ez_setup.py | ||
| INSTALL | ||
| LICENSE | ||
| README | ||
| setup.py | ||
| testall.py | ||
| todo1.0 | ||
SleekXMPP is an XMPP library written for Python 3.1+ (with 2.6 compatibility). Hosted at http://wiki.github.com/fritzy/SleekXMPP/ Featured in examples in XMPP: The Definitive Guide by Kevin Smith, Remko Tronçon, and Peter Saint-Andre If you're coming here from The Definitive Guide, please read http://wiki.github.com/fritzy/SleekXMPP/xmpp-the-definitive-guide Requirements: We try to keep requirements to a minimum, but we suggest that you install http://dnspython.org although it isn't strictly required. If you do not install this library, you may need to specify the server/port for services that use SRV records (like GTalk). "sudo pip install dnspython" on a *nix system with pip installed. SleekXMPP has several design goals/philosophies: - Low number of dependencies. - Every XEP as a plugin. - Rewarding to work with. The goals for 1.0 include (and we're getting close): - Nearly Full test coverage of stanzas. - Wide range of functional tests. - Stanza objects for all interaction with the stream - Documentation on using and extending SleekXMPP. - Complete documentation on all implemented stanza objects - Documentation on all examples used in XMPP: The Definitive Guide 1.1 will include: - More functional and unit tests - PEP-8 compliance - XEP-225 support Since 0.2, here's the Changelog: - MANY bugfixes - Re-implementation of handlers/threading to greatly simplify and remove bugs (no more spawning threads in handlers) - Stanza objects for jabber:client and all implemented XEPs - Raising XMPPError for jabber:client and extended errors in handlers - Robust error handling and better insurance of iq responses - Stanza objects have made life a lot easier! - Massive audit/cleanup. Credits ---------------- Main Author: Nathan Fritz fritz@netflint.net Contributors: Kevin Smith & Lance Stout Patches: Remko Tronçon Feel free to add fritzy@netflint.net to your roster for direct support and comments. Join sleekxmpp-discussion@googlegroups.com / http://groups.google.com/group/sleekxmpp-discussion for email discussion. Join sleek@conference.jabber.org for groupchat discussion.