jshiffer/slixmpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remove all deprecated alias in the core of slixmpp, and wherever they were used.

Browse Source
This commit is contained in:
Emmanuel Gil Peyrot 2014-09-21 18:51:06 +02:00 committed by Florent Le Coz
parent 61f89eef2e
commit 7c3e61950d
29 changed files with 80 additions and 206 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/create_plugin.rst
View File

@ -29,7 +29,7 @@ in the future.
First Steps First Steps
----------- -----------
Every plugin inherits from the class :mod:`base_plugin <slixmpp.plugins.base.base_plugin>`, Every plugin inherits from the class :mod:`BasePlugin <slixmpp.plugins.base.BasePlugin`,
and must include a ``plugin_init`` method. While the and must include a ``plugin_init`` method. While the
plugins distributed with Slixmpp must be placed in the plugins directory plugins distributed with Slixmpp must be placed in the plugins directory
``slixmpp/plugins`` to be loaded, custom plugins may be loaded from any ``slixmpp/plugins`` to be loaded, custom plugins may be loaded from any
@ -56,9 +56,9 @@ attribute.
as a tutorial for creating Slixmpp plugins. as a tutorial for creating Slixmpp plugins.
""" """
from slixmpp.plugins.base import base_plugin from slixmpp.plugins.base import BasePlugin
class xep_0077(base_plugin): class xep_0077(BasePlugin):
""" """
XEP-0077 In-Band Registration XEP-0077 In-Band Registration
""" """
@ -81,7 +81,7 @@ call in a method named ``post_init`` which will be called once the plugin has
been loaded; by doing so we advertise that we can do registrations only after we been loaded; by doing so we advertise that we can do registrations only after we
finish activating the plugin. finish activating the plugin.
The ``post_init`` method needs to call ``base_plugin.post_init(self)`` The ``post_init`` method needs to call ``BasePlugin.post_init(self)``
which will mark that ``post_init`` has been called for the plugin. Once the which will mark that ``post_init`` has been called for the plugin. Once the
Slixmpp object begins processing, ``post_init`` will be called on any plugins Slixmpp object begins processing, ``post_init`` will be called on any plugins
that have not already run ``post_init``. This allows you to register plugins and that have not already run ``post_init``. This allows you to register plugins and
@ -94,7 +94,7 @@ does not automatically load plugin dependencies for you.
.. code-block:: python .. code-block:: python
def post_init(self): def post_init(self):
base_plugin.post_init(self) BasePlugin.post_init(self)
self.xmpp['xep_0030'].add_feature("jabber:iq:register") self.xmpp['xep_0030'].add_feature("jabber:iq:register")
Creating Custom Stanza Objects Creating Custom Stanza Objects
@ -347,7 +347,7 @@ method ``setForm`` which will take the names of the fields we wish to include.
# Add a blank field # Add a blank field
reg.addField(field) reg.addField(field)
iq.reply().setPayload(reg.xml) iq.reply().set_payload(reg.xml)
iq.send() iq.send()
Note how we are able to access our ``Registration`` stanza object with Note how we are able to access our ``Registration`` stanza object with
@ -421,7 +421,7 @@ to the IQ reply.
... ...
def _sendError(self, iq, code, error_type, name, text=''): def _sendError(self, iq, code, error_type, name, text=''):
iq.reply().setPayload(iq['register'].xml) iq.reply().set_payload(iq['register'].xml)
iq.error() iq.error()
iq['error']['code'] = code iq['error']['code'] = code
iq['error']['type'] = error_type iq['error']['type'] = error_type
@ -464,7 +464,7 @@ component examples below for how to respond to this event.
if self.backend.register(iq['from'].bare, iq['register']): if self.backend.register(iq['from'].bare, iq['register']):
# Successful registration # Successful registration
self.xmpp.event('registered_user', iq) self.xmpp.event('registered_user', iq)
iq.reply().setPayload(iq['register'].xml) iq.reply().set_payload(iq['register'].xml)
iq.send() iq.send()
else: else:
# Conflicting registration # Conflicting registration
@ -491,8 +491,8 @@ and that we specified the form fields we wish to use with
def __init__(self, jid, password): def __init__(self, jid, password):
slixmpp.componentxmpp.ComponentXMPP.__init__(self, jid, password, 'localhost', 8888) slixmpp.componentxmpp.ComponentXMPP.__init__(self, jid, password, 'localhost', 8888)
self.registerPlugin('xep_0030') self.register_plugin('xep_0030')
self.registerPlugin('xep_0077') self.register_plugin('xep_0077')
self.plugin['xep_0077'].setForm('username', 'password') self.plugin['xep_0077'].setForm('username', 'password')
self.add_event_handler("registered_user", self.reg) self.add_event_handler("registered_user", self.reg)
@ -500,11 +500,11 @@ and that we specified the form fields we wish to use with
def reg(self, iq): def reg(self, iq):
msg = "Welcome! %s" % iq['register']['username'] msg = "Welcome! %s" % iq['register']['username']
self.sendMessage(iq['from'], msg, mfrom=self.fulljid) self.send_message(iq['from'], msg, mfrom=self.fulljid)
def unreg(self, iq): def unreg(self, iq):
msg = "Bye! %s" % iq['register']['username'] msg = "Bye! %s" % iq['register']['username']
self.sendMessage(iq['from'], msg, mfrom=self.fulljid) self.send_message(iq['from'], msg, mfrom=self.fulljid)
**Congratulations!** We now have a basic, functioning implementation of **Congratulations!** We now have a basic, functioning implementation of
XEP-0077. XEP-0077.
@ -523,7 +523,7 @@ with some additional registration fields implemented.
as a tutorial for creating Slixmpp plugins. as a tutorial for creating Slixmpp plugins.
""" """
from slixmpp.plugins.base import base_plugin from slixmpp.plugins.base import BasePlugin
from slixmpp.xmlstream.handler.callback import Callback from slixmpp.xmlstream.handler.callback import Callback
from slixmpp.xmlstream.matcher.xpath import MatchXPath from slixmpp.xmlstream.matcher.xpath import MatchXPath
from slixmpp.xmlstream import ElementBase, ET, JID, register_stanza_plugin from slixmpp.xmlstream import ElementBase, ET, JID, register_stanza_plugin
@ -589,7 +589,7 @@ with some additional registration fields implemented.
def unregister(self, jid): def unregister(self, jid):
del self.users[jid] del self.users[jid]
class xep_0077(base_plugin): class xep_0077(BasePlugin):
""" """
XEP-0077 In-Band Registration XEP-0077 In-Band Registration
""" """
@ -608,7 +608,7 @@ with some additional registration fields implemented.
register_stanza_plugin(Iq, Registration) register_stanza_plugin(Iq, Registration)
def post_init(self): def post_init(self):
base_plugin.post_init(self) BasePlugin.post_init(self)
self.xmpp['xep_0030'].add_feature("jabber:iq:register") self.xmpp['xep_0030'].add_feature("jabber:iq:register")
def __handleRegistration(self, iq): def __handleRegistration(self, iq):
@ -634,7 +634,7 @@ with some additional registration fields implemented.
if self.backend.register(iq['from'].bare, iq['register']): if self.backend.register(iq['from'].bare, iq['register']):
# Successful registration # Successful registration
self.xmpp.event('registered_user', iq) self.xmpp.event('registered_user', iq)
iq.reply().setPayload(iq['register'].xml) iq.reply().set_payload(iq['register'].xml)
iq.send() iq.send()
else: else:
# Conflicting registration # Conflicting registration
@ -666,11 +666,11 @@ with some additional registration fields implemented.
# Add a blank field # Add a blank field
reg.addField(field) reg.addField(field)
iq.reply().setPayload(reg.xml) iq.reply().set_payload(reg.xml)
iq.send() iq.send()
def _sendError(self, iq, code, error_type, name, text=''): def _sendError(self, iq, code, error_type, name, text=''):
iq.reply().setPayload(iq['register'].xml) iq.reply().set_payload(iq['register'].xml)
iq.error() iq.error()
iq['error']['code'] = code iq['error']['code'] = code
iq['error']['type'] = error_type iq['error']['type'] = error_type

2
docs/getting_started/echobot.rst
View File

@ -348,7 +348,7 @@ to :meth:`slixmpp.clientxmpp.ClientXMPP`.
To begin responding to messages, you'll see we called :meth:`slixmpp.basexmpp.BaseXMPP.process` To begin responding to messages, you'll see we called :meth:`slixmpp.basexmpp.BaseXMPP.process`
which will start the event handling, send queue, and XML reader threads. It will also call which will start the event handling, send queue, and XML reader threads. It will also call
the :meth:`slixmpp.plugins.base.base_plugin.post_init` method on all registered plugins. By the :meth:`slixmpp.plugins.base.BasePlugin.post_init` method on all registered plugins. By
passing ``block=True`` to :meth:`slixmpp.basexmpp.BaseXMPP.process` we are running the passing ``block=True`` to :meth:`slixmpp.basexmpp.BaseXMPP.process` we are running the
main processing loop in the main thread of execution. The :meth:`slixmpp.basexmpp.BaseXMPP.process` main processing loop in the main thread of execution. The :meth:`slixmpp.basexmpp.BaseXMPP.process`
call will not return until after Slixmpp disconnects. If you need to run the client in the background call will not return until after Slixmpp disconnects. If you need to run the client in the background

20
docs/xmpp_tdg.rst
View File

@ -36,7 +36,7 @@ Updated Code
.. code-block:: python .. code-block:: python
def handleIncomingMessage(self, message): def handleIncomingMessage(self, message):
self.xmpp.sendMessage(message["from"], message["body"]) self.xmpp.send_message(message["from"], message["body"])
`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/EchoBot/EchoBot.py>`_ | `View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/EchoBot/EchoBot.py>`_ |
`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/EchoBot/EchoBot.py>`_ `View original code <http://github.com/remko/xmpp-tdg/blob/master/code/EchoBot/EchoBot.py>`_
@ -86,7 +86,7 @@ Updated Code
"uri": self.url + "/" + message.user, "uri": self.url + "/" + message.user,
"user" : message.user, "message" : message.text } "user" : message.user, "message" : message.text }
for subscriberJID in self.backend.getSubscriberJIDs(message.user) : for subscriberJID in self.backend.getSubscriberJIDs(message.user) :
self.xmpp.sendMessage(subscriberJID, body, mhtml=htmlBody) self.xmpp.send_message(subscriberJID, body, mhtml=htmlBody)
`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/Bot.py>`_ | `View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/Bot.py>`_ |
`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/Bot.py>`_ `View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/Bot.py>`_
@ -145,7 +145,7 @@ Example 14-4. (Page 220)
Like several previous examples, a needed change is to replace Like several previous examples, a needed change is to replace
``subscription["from"]`` with ``subscription["from"].jid`` because the ``subscription["from"]`` with ``subscription["from"].jid`` because the
``BaseXMPP`` method ``makePresence`` requires the JID to be a string. ``BaseXMPP`` method ``make_presence`` requires the JID to be a string.
A correction needs to be made in ``handleXMPPPresenceProbe`` because a line was A correction needs to be made in ``handleXMPPPresenceProbe`` because a line was
left out of the original implementation; the variable ``user`` is undefined. The left out of the original implementation; the variable ``user`` is undefined. The
@ -154,7 +154,7 @@ JID of the user can be extracted from the presence stanza's ``from`` attribute.
Since this implementation of CheshiR uses an XMPP component, it must Since this implementation of CheshiR uses an XMPP component, it must
include a ``from`` attribute in all messages that it sends. Adding the include a ``from`` attribute in all messages that it sends. Adding the
``from`` attribute is done by including ``mfrom=self.xmpp.jid`` in calls to ``from`` attribute is done by including ``mfrom=self.xmpp.jid`` in calls to
``self.xmpp.sendMessage``. ``self.xmpp.send_message``.
Updated Code Updated Code
~~~~~~~~~~~~ ~~~~~~~~~~~~
@ -162,19 +162,19 @@ Updated Code
.. code-block:: python .. code-block:: python
def handleXMPPPresenceProbe(self, event) : def handleXMPPPresenceProbe(self, event) :
self.xmpp.sendPresence(pto = event["from"]) self.xmpp.send_presence(pto = event["from"])
def handleXMPPPresenceSubscription(self, subscription) : def handleXMPPPresenceSubscription(self, subscription) :
if subscription["type"] == "subscribe" : if subscription["type"] == "subscribe" :
userJID = subscription["from"].jid userJID = subscription["from"].jid
self.xmpp.sendPresenceSubscription(pto=userJID, ptype="subscribed") self.xmpp.send_presence_subscription(pto=userJID, ptype="subscribed")
self.xmpp.sendPresence(pto = userJID) self.xmpp.send_presence(pto = userJID)
self.xmpp.sendPresenceSubscription(pto=userJID, ptype="subscribe") self.xmpp.send_presence_subscription(pto=userJID, ptype="subscribe")
def handleMessageAddedToBackend(self, message) : def handleMessageAddedToBackend(self, message) :
body = message.user + ": " + message.text body = message.user + ": " + message.text
for subscriberJID in self.backend.getSubscriberJIDs(message.user) : for subscriberJID in self.backend.getSubscriberJIDs(message.user) :
self.xmpp.sendMessage(subscriberJID, body, mfrom=self.xmpp.jid) self.xmpp.send_message(subscriberJID, body, mfrom=self.xmpp.jid)
`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/SimpleComponent.py>`_ | `View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/SimpleComponent.py>`_ |
`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/SimpleComponent.py>`_ `View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/SimpleComponent.py>`_
@ -239,7 +239,7 @@ Updated Code
userJID = subscription["from"].jid userJID = subscription["from"].jid
user = self.backend.getUserFromJID(userJID) user = self.backend.getUserFromJID(userJID)
contactJID = subscription["to"] contactJID = subscription["to"]
self.xmpp.sendPresenceSubscription( self.xmpp.send_presence_subscription(
pfrom=contactJID, pto=userJID, ptype="subscribed", pnick=user) pfrom=contactJID, pto=userJID, ptype="subscribed", pnick=user)
self.sendPresenceOfContactToUser(contactJID=contactJID, userJID=userJID) self.sendPresenceOfContactToUser(contactJID=contactJID, userJID=userJID)
if contactJID == self.componentDomain : if contactJID == self.componentDomain :

8
examples/echo_component.py
View File

@ -95,10 +95,10 @@ if __name__ == '__main__':
# may have interdependencies, the order in which you register them does # may have interdependencies, the order in which you register them does
# not matter. # not matter.
xmpp = EchoComponent(args.jid, args.password, args.server, args.port) xmpp = EchoComponent(args.jid, args.password, args.server, args.port)
xmpp.registerPlugin('xep_0030') # Service Discovery xmpp.register_plugin('xep_0030') # Service Discovery
xmpp.registerPlugin('xep_0004') # Data Forms xmpp.register_plugin('xep_0004') # Data Forms
xmpp.registerPlugin('xep_0060') # PubSub xmpp.register_plugin('xep_0060') # PubSub
xmpp.registerPlugin('xep_0199') # XMPP Ping xmpp.register_plugin('xep_0199') # XMPP Ping
# Connect to the XMPP server and start processing XMPP stanzas. # Connect to the XMPP server and start processing XMPP stanzas.
xmpp.connect() xmpp.connect()

20
slixmpp/basexmpp.py
View File

@ -779,23 +779,3 @@ class BaseXMPP(XMLStream):
pass pass
else: else:
log.exception(exception) log.exception(exception)
# Restore the old, lowercased name for backwards compatibility.
basexmpp = BaseXMPP
# To comply with PEP8, method names now use underscores.
# Deprecated method names are re-mapped for backwards compatibility.
BaseXMPP.registerPlugin = BaseXMPP.register_plugin
BaseXMPP.makeIq = BaseXMPP.make_iq
BaseXMPP.makeIqGet = BaseXMPP.make_iq_get
BaseXMPP.makeIqResult = BaseXMPP.make_iq_result
BaseXMPP.makeIqSet = BaseXMPP.make_iq_set
BaseXMPP.makeIqError = BaseXMPP.make_iq_error
BaseXMPP.makeIqQuery = BaseXMPP.make_iq_query
BaseXMPP.makeQueryRoster = BaseXMPP.make_query_roster
BaseXMPP.makeMessage = BaseXMPP.make_message
BaseXMPP.makePresence = BaseXMPP.make_presence
BaseXMPP.sendMessage = BaseXMPP.send_message
BaseXMPP.sendPresence = BaseXMPP.send_presence
BaseXMPP.sendPresenceSubscription = BaseXMPP.send_presence_subscription

8
slixmpp/clientxmpp.py
View File

@ -300,11 +300,3 @@ class ClientXMPP(BaseXMPP):
dictated by the server. The same as :attr:`boundjid`. dictated by the server. The same as :attr:`boundjid`.
""" """
self.client_roster = self.roster[jid] self.client_roster = self.roster[jid]
# To comply with PEP8, method names now use underscores.
# Deprecated method names are re-mapped for backwards compatibility.
ClientXMPP.updateRoster = ClientXMPP.update_roster
ClientXMPP.delRosterItem = ClientXMPP.del_roster_item
ClientXMPP.getRoster = ClientXMPP.get_roster
ClientXMPP.registerFeature = ClientXMPP.register_feature

3
slixmpp/plugins/base.py
View File

@ -351,6 +351,3 @@ class BasePlugin(object):
Only needed if the plugin has circular dependencies. Only needed if the plugin has circular dependencies.
""" """
pass pass
base_plugin = BasePlugin

12
slixmpp/plugins/gmail_notify.py
View File

@ -7,10 +7,10 @@
""" """
import logging import logging
from . import base from slixmpp.plugins import BasePlugin
from .. xmlstream.handler.callback import Callback from .. xmlstream.handler.callback import Callback
from .. xmlstream.matcher.xpath import MatchXPath from .. xmlstream.matcher.xpath import MatchXPath
from .. xmlstream.stanzabase import registerStanzaPlugin, ElementBase, ET, JID from .. xmlstream.stanzabase import register_stanza_plugin, ElementBase, ET, JID
from .. stanza.iq import Iq from .. stanza.iq import Iq
@ -90,7 +90,7 @@ class NewMail(ElementBase):
plugin_attrib = 'new-mail' plugin_attrib = 'new-mail'
class gmail_notify(base.base_plugin): class gmail_notify(BasePlugin):
""" """
Google Talk: Gmail Notifications Google Talk: Gmail Notifications
""" """
@ -112,9 +112,9 @@ class gmail_notify(base.base_plugin):
NewMail.name)), NewMail.name)),
self.handle_new_mail)) self.handle_new_mail))
registerStanzaPlugin(Iq, GmailQuery) register_stanza_plugin(Iq, GmailQuery)
registerStanzaPlugin(Iq, MailBox) register_stanza_plugin(Iq, MailBox)
registerStanzaPlugin(Iq, NewMail) register_stanza_plugin(Iq, NewMail)
self.last_result_time = None self.last_result_time = None

5
slixmpp/plugins/xep_0004/stanza/form.py
View File

@ -237,21 +237,16 @@ class Form(ElementBase):
return new return new
Form.setType = Form.set_type
Form.addField = Form.add_field Form.addField = Form.add_field
Form.addItem = Form.add_item
Form.addReported = Form.add_reported Form.addReported = Form.add_reported
Form.delFields = Form.del_fields Form.delFields = Form.del_fields
Form.delInstructions = Form.del_instructions Form.delInstructions = Form.del_instructions
Form.delItems = Form.del_items
Form.delReported = Form.del_reported Form.delReported = Form.del_reported
Form.getFields = Form.get_fields Form.getFields = Form.get_fields
Form.getInstructions = Form.get_instructions Form.getInstructions = Form.get_instructions
Form.getItems = Form.get_items
Form.getReported = Form.get_reported Form.getReported = Form.get_reported
Form.getValues = Form.get_values Form.getValues = Form.get_values
Form.setFields = Form.set_fields Form.setFields = Form.set_fields
Form.setInstructions = Form.set_instructions Form.setInstructions = Form.set_instructions
Form.setItems = Form.set_items
Form.setReported = Form.set_reported Form.setReported = Form.set_reported
Form.setValues = Form.set_values Form.setValues = Form.set_values

12
slixmpp/plugins/xep_0009/remote.py
View File

@ -453,7 +453,7 @@ class RemoteSession(object):
def _notify(self, event): def _notify(self, event):
log.debug("RPC Session as %s started.", self._client.boundjid.full) log.debug("RPC Session as %s started.", self._client.boundjid.full)
self._client.sendPresence() self._client.send_presence()
self._event.set() self._event.set()
pass pass
@ -733,10 +733,10 @@ class Remote(object):
''' '''
client = slixmpp.ClientXMPP(jid, password) client = slixmpp.ClientXMPP(jid, password)
#? Register plug-ins. #? Register plug-ins.
client.registerPlugin('xep_0004') # Data Forms client.register_plugin('xep_0004') # Data Forms
client.registerPlugin('xep_0009') # Jabber-RPC client.register_plugin('xep_0009') # Jabber-RPC
client.registerPlugin('xep_0030') # Service Discovery client.register_plugin('xep_0030') # Service Discovery
client.registerPlugin('xep_0060') # PubSub client.register_plugin('xep_0060') # PubSub
client.registerPlugin('xep_0199') # XMPP Ping client.register_plugin('xep_0199') # XMPP Ping
return cls.new_session_with_client(client, callback) return cls.new_session_with_client(client, callback)

8
slixmpp/plugins/xep_0009/rpc.py
View File

@ -55,7 +55,7 @@ class XEP_0009(BasePlugin):
self.xmpp['xep_0030'].add_identity('automation','rpc') self.xmpp['xep_0030'].add_identity('automation','rpc')
def make_iq_method_call(self, pto, pmethod, params): def make_iq_method_call(self, pto, pmethod, params):
iq = self.xmpp.makeIqSet() iq = self.xmpp.make_iq_set()
iq.attrib['to'] = pto iq.attrib['to'] = pto
iq.attrib['from'] = self.xmpp.boundjid.full iq.attrib['from'] = self.xmpp.boundjid.full
iq.enable('rpc_query') iq.enable('rpc_query')
@ -64,7 +64,7 @@ class XEP_0009(BasePlugin):
return iq return iq
def make_iq_method_response(self, pid, pto, params): def make_iq_method_response(self, pid, pto, params):
iq = self.xmpp.makeIqResult(pid) iq = self.xmpp.make_iq_result(pid)
iq.attrib['to'] = pto iq.attrib['to'] = pto
iq.attrib['from'] = self.xmpp.boundjid.full iq.attrib['from'] = self.xmpp.boundjid.full
iq.enable('rpc_query') iq.enable('rpc_query')
@ -72,7 +72,7 @@ class XEP_0009(BasePlugin):
return iq return iq
def make_iq_method_response_fault(self, pid, pto, params): def make_iq_method_response_fault(self, pid, pto, params):
iq = self.xmpp.makeIqResult(pid) iq = self.xmpp.make_iq_result(pid)
iq.attrib['to'] = pto iq.attrib['to'] = pto
iq.attrib['from'] = self.xmpp.boundjid.full iq.attrib['from'] = self.xmpp.boundjid.full
iq.enable('rpc_query') iq.enable('rpc_query')
@ -81,7 +81,7 @@ class XEP_0009(BasePlugin):
return iq return iq
# def make_iq_method_error(self, pto, pid, pmethod, params, code, type, condition): # def make_iq_method_error(self, pto, pid, pmethod, params, code, type, condition):
# iq = self.xmpp.makeIqError(pid) # iq = self.xmpp.make_iq_error(pid)
# iq.attrib['to'] = pto # iq.attrib['to'] = pto
# iq.attrib['from'] = self.xmpp.boundjid.full # iq.attrib['from'] = self.xmpp.boundjid.full
# iq['error']['code'] = code # iq['error']['code'] = code

1
slixmpp/plugins/xep_0030/__init__.py
View File

@ -19,5 +19,4 @@ register_plugin(XEP_0030)
# Retain some backwards compatibility # Retain some backwards compatibility
xep_0030 = XEP_0030 xep_0030 = XEP_0030
XEP_0030.getInfo = XEP_0030.get_info XEP_0030.getInfo = XEP_0030.get_info
XEP_0030.getItems = XEP_0030.get_items
XEP_0030.make_static = XEP_0030.restore_defaults XEP_0030.make_static = XEP_0030.restore_defaults

24
slixmpp/plugins/xep_0045.py
View File

@ -154,7 +154,7 @@ class XEP_0045(BasePlugin):
got_online = False got_online = False
if pr['muc']['room'] not in self.rooms.keys(): if pr['muc']['room'] not in self.rooms.keys():
return return
entry = pr['muc'].getStanzaValues() entry = pr['muc'].get_stanza_values()
entry['show'] = pr['show'] entry['show'] = pr['show']
entry['status'] = pr['status'] entry['status'] = pr['status']
entry['alt_nick'] = pr['nick'] entry['alt_nick'] = pr['nick']
@ -210,7 +210,7 @@ class XEP_0045(BasePlugin):
def configureRoom(self, room, form=None, ifrom=None): def configureRoom(self, room, form=None, ifrom=None):
if form is None: if form is None:
form = self.getRoomConfig(room, ifrom=ifrom) form = self.getRoomConfig(room, ifrom=ifrom)
iq = self.xmpp.makeIqSet() iq = self.xmpp.make_iq_set()
iq['to'] = room iq['to'] = room
if ifrom is not None: if ifrom is not None:
iq['from'] = ifrom iq['from'] = ifrom
@ -230,7 +230,7 @@ class XEP_0045(BasePlugin):
def joinMUC(self, room, nick, maxhistory="0", password='', wait=False, pstatus=None, pshow=None, pfrom=None): def joinMUC(self, room, nick, maxhistory="0", password='', wait=False, pstatus=None, pshow=None, pfrom=None):
""" Join the specified room, requesting 'maxhistory' lines of history. """ Join the specified room, requesting 'maxhistory' lines of history.
""" """
stanza = self.xmpp.makePresence(pto="%s/%s" % (room, nick), pstatus=pstatus, pshow=pshow, pfrom=pfrom) stanza = self.xmpp.make_presence(pto="%s/%s" % (room, nick), pstatus=pstatus, pshow=pshow, pfrom=pfrom)
x = ET.Element('{http://jabber.org/protocol/muc}x') x = ET.Element('{http://jabber.org/protocol/muc}x')
if password: if password:
passelement = ET.Element('{http://jabber.org/protocol/muc}password') passelement = ET.Element('{http://jabber.org/protocol/muc}password')
@ -254,7 +254,7 @@ class XEP_0045(BasePlugin):
self.ourNicks[room] = nick self.ourNicks[room] = nick
def destroy(self, room, reason='', altroom = '', ifrom=None): def destroy(self, room, reason='', altroom = '', ifrom=None):
iq = self.xmpp.makeIqSet() iq = self.xmpp.make_iq_set()
if ifrom is not None: if ifrom is not None:
iq['from'] = ifrom iq['from'] = ifrom
iq['to'] = room iq['to'] = room
@ -286,7 +286,7 @@ class XEP_0045(BasePlugin):
else: else:
item = ET.Element('{http://jabber.org/protocol/muc#admin}item', {'affiliation':affiliation, 'jid':jid}) item = ET.Element('{http://jabber.org/protocol/muc#admin}item', {'affiliation':affiliation, 'jid':jid})
query.append(item) query.append(item)
iq = self.xmpp.makeIqSet(query) iq = self.xmpp.make_iq_set(query)
iq['to'] = room iq['to'] = room
iq['from'] = ifrom iq['from'] = ifrom
# For now, swallow errors to preserve existing API # For now, swallow errors to preserve existing API
@ -309,7 +309,7 @@ class XEP_0045(BasePlugin):
query = ET.Element('{http://jabber.org/protocol/muc#admin}query') query = ET.Element('{http://jabber.org/protocol/muc#admin}query')
item = ET.Element('item', {'role':role, 'nick':nick}) item = ET.Element('item', {'role':role, 'nick':nick})
query.append(item) query.append(item)
iq = self.xmpp.makeIqSet(query) iq = self.xmpp.make_iq_set(query)
iq['to'] = room iq['to'] = room
result = iq.send() result = iq.send()
if result is False or result['type'] != 'result': if result is False or result['type'] != 'result':
@ -318,7 +318,7 @@ class XEP_0045(BasePlugin):
def invite(self, room, jid, reason='', mfrom=''): def invite(self, room, jid, reason='', mfrom=''):
""" Invite a jid to a room.""" """ Invite a jid to a room."""
msg = self.xmpp.makeMessage(room) msg = self.xmpp.make_message(room)
msg['from'] = mfrom msg['from'] = mfrom
x = ET.Element('{http://jabber.org/protocol/muc#user}x') x = ET.Element('{http://jabber.org/protocol/muc#user}x')
invite = ET.Element('{http://jabber.org/protocol/muc#user}invite', {'to': jid}) invite = ET.Element('{http://jabber.org/protocol/muc#user}invite', {'to': jid})
@ -334,13 +334,13 @@ class XEP_0045(BasePlugin):
""" Leave the specified room. """ Leave the specified room.
""" """
if msg: if msg:
self.xmpp.sendPresence(pshow='unavailable', pto="%s/%s" % (room, nick), pstatus=msg, pfrom=pfrom) self.xmpp.send_presence(pshow='unavailable', pto="%s/%s" % (room, nick), pstatus=msg, pfrom=pfrom)
else: else:
self.xmpp.sendPresence(pshow='unavailable', pto="%s/%s" % (room, nick), pfrom=pfrom) self.xmpp.send_presence(pshow='unavailable', pto="%s/%s" % (room, nick), pfrom=pfrom)
del self.rooms[room] del self.rooms[room]
def getRoomConfig(self, room, ifrom=''): def getRoomConfig(self, room, ifrom=''):
iq = self.xmpp.makeIqGet('http://jabber.org/protocol/muc#owner') iq = self.xmpp.make_iq_get('http://jabber.org/protocol/muc#owner')
iq['to'] = room iq['to'] = room
iq['from'] = ifrom iq['from'] = ifrom
# For now, swallow errors to preserve existing API # For now, swallow errors to preserve existing API
@ -359,7 +359,7 @@ class XEP_0045(BasePlugin):
query = ET.Element('{http://jabber.org/protocol/muc#owner}query') query = ET.Element('{http://jabber.org/protocol/muc#owner}query')
x = ET.Element('{jabber:x:data}x', type='cancel') x = ET.Element('{jabber:x:data}x', type='cancel')
query.append(x) query.append(x)
iq = self.xmpp.makeIqSet(query) iq = self.xmpp.make_iq_set(query)
iq['to'] = room iq['to'] = room
iq['from'] = ifrom iq['from'] = ifrom
iq.send() iq.send()
@ -368,7 +368,7 @@ class XEP_0045(BasePlugin):
query = ET.Element('{http://jabber.org/protocol/muc#owner}query') query = ET.Element('{http://jabber.org/protocol/muc#owner}query')
x = config.getXML('submit') x = config.getXML('submit')
query.append(x) query.append(x)
iq = self.xmpp.makeIqSet(query) iq = self.xmpp.make_iq_set(query)
iq['to'] = room iq['to'] = room
iq['from'] = ifrom iq['from'] = ifrom
iq.send() iq.send()

4
slixmpp/plugins/xep_0050/adhoc.py
View File

@ -57,8 +57,8 @@ class XEP_0050(BasePlugin):
relevant to a command's session. relevant to a command's session.
Methods: Methods:
plugin_init -- Overrides base_plugin.plugin_init plugin_init -- Overrides BasePlugin.plugin_init
post_init -- Overrides base_plugin.post_init post_init -- Overrides BasePlugin.post_init
new_session -- Return a new session ID. new_session -- Return a new session ID.
prep_handlers -- Placeholder. May call with a list of handlers prep_handlers -- Placeholder. May call with a list of handlers
to prepare them for use with the session storage to prepare them for use with the session storage

4
slixmpp/plugins/xep_0065/proxy.py
View File

@ -12,7 +12,7 @@ from slixmpp.exceptions import XMPPError
from slixmpp.xmlstream import register_stanza_plugin from slixmpp.xmlstream import register_stanza_plugin
from slixmpp.xmlstream.handler import Callback from slixmpp.xmlstream.handler import Callback
from slixmpp.xmlstream.matcher import StanzaPath from slixmpp.xmlstream.matcher import StanzaPath
from slixmpp.plugins.base import base_plugin from slixmpp.plugins.base import BasePlugin
from slixmpp.plugins.xep_0065 import stanza, Socks5 from slixmpp.plugins.xep_0065 import stanza, Socks5
@ -20,7 +20,7 @@ from slixmpp.plugins.xep_0065 import stanza, Socks5
log = logging.getLogger(__name__) log = logging.getLogger(__name__)
class XEP_0065(base_plugin): class XEP_0065(BasePlugin):
name = 'xep_0065' name = 'xep_0065'
description = "Socks5 Bytestreams" description = "Socks5 Bytestreams"

6
slixmpp/plugins/xep_0323/sensordata.py
View File

@ -83,9 +83,9 @@ class XEP_0323(BasePlugin):
sequence number (unique between the client/sensor pair) sequence number (unique between the client/sensor pair)
Methods: Methods:
plugin_init -- Overrides base_plugin.plugin_init plugin_init -- Overrides BasePlugin.plugin_init
post_init -- Overrides base_plugin.post_init post_init -- Overrides BasePlugin.post_init
plugin_end -- Overrides base_plugin.plugin_end plugin_end -- Overrides BasePlugin.plugin_end
Sensor side Sensor side
----------- -----------

6
slixmpp/plugins/xep_0325/control.py
View File

@ -79,9 +79,9 @@ class XEP_0325(BasePlugin):
sequence number (unique between the client/sensor pair) sequence number (unique between the client/sensor pair)
Methods: Methods:
plugin_init -- Overrides base_plugin.plugin_init plugin_init -- Overrides BasePlugin.plugin_init
post_init -- Overrides base_plugin.post_init post_init -- Overrides BasePlugin.post_init
plugin_end -- Overrides base_plugin.plugin_end plugin_end -- Overrides BasePlugin.plugin_end
Sensor side Sensor side
----------- -----------

10
slixmpp/stanza/error.py
View File

@ -162,13 +162,3 @@ class Error(ElementBase):
def del_redirect(self): def del_redirect(self):
self._del_sub('{%s}redirect' % self.condition_ns) self._del_sub('{%s}redirect' % self.condition_ns)
# To comply with PEP8, method names now use underscores.
# Deprecated method names are re-mapped for backwards compatibility.
Error.getCondition = Error.get_condition
Error.setCondition = Error.set_condition
Error.delCondition = Error.del_condition
Error.getText = Error.get_text
Error.setText = Error.set_text
Error.delText = Error.del_text

7
slixmpp/stanza/htmlim.py
View File

@ -12,10 +12,3 @@ from slixmpp.plugins.xep_0071 import XHTML_IM as HTMLIM
register_stanza_plugin(Message, HTMLIM) register_stanza_plugin(Message, HTMLIM)
# To comply with PEP8, method names now use underscores.
# Deprecated method names are re-mapped for backwards compatibility.
HTMLIM.setBody = HTMLIM.set_body
HTMLIM.getBody = HTMLIM.get_body
HTMLIM.delBody = HTMLIM.del_body

8
slixmpp/stanza/iq.py
View File

@ -246,11 +246,3 @@ class Iq(RootStanza):
else: else:
StanzaBase._set_stanza_values(self, values) StanzaBase._set_stanza_values(self, values)
return self return self
# To comply with PEP8, method names now use underscores.
# Deprecated method names are re-mapped for backwards compatibility.
Iq.setPayload = Iq.set_payload
Iq.getQuery = Iq.get_query
Iq.setQuery = Iq.set_query
Iq.delQuery = Iq.del_query

11
slixmpp/stanza/message.py
View File

@ -186,14 +186,3 @@ class Message(RootStanza):
def del_mucnick(self): def del_mucnick(self):
"""Dummy method to prevent deletion.""" """Dummy method to prevent deletion."""
pass pass
# To comply with PEP8, method names now use underscores.
# Deprecated method names are re-mapped for backwards compatibility.
Message.getType = Message.get_type
Message.getMucroom = Message.get_mucroom
Message.setMucroom = Message.set_mucroom
Message.delMucroom = Message.del_mucroom
Message.getMucnick = Message.get_mucnick
Message.setMucnick = Message.set_mucnick
Message.delMucnick = Message.del_mucnick

6
slixmpp/stanza/nick.py
View File

@ -15,9 +15,3 @@ from slixmpp.plugins.xep_0172 import UserNick as Nick
register_stanza_plugin(Message, Nick) register_stanza_plugin(Message, Nick)
register_stanza_plugin(Presence, Nick) register_stanza_plugin(Presence, Nick)
# To comply with PEP8, method names now use underscores.
# Deprecated method names are re-mapped for backwards compatibility.
Nick.setNick = Nick.set_nick
Nick.getNick = Nick.get_nick
Nick.delNick = Nick.del_nick

10
slixmpp/stanza/presence.py
View File

@ -179,13 +179,3 @@ class Presence(RootStanza):
elif self['type'] == 'subscribe': elif self['type'] == 'subscribe':
self['type'] = 'subscribed' self['type'] = 'subscribed'
return StanzaBase.reply(self, clear) return StanzaBase.reply(self, clear)
# To comply with PEP8, method names now use underscores.
# Deprecated method names are re-mapped for backwards compatibility.
Presence.setShow = Presence.set_show
Presence.getType = Presence.get_type
Presence.setType = Presence.set_type
Presence.delType = Presence.get_type
Presence.getPriority = Presence.get_priority
Presence.setPriority = Presence.set_priority

6
slixmpp/stanza/roster.py
View File

@ -150,9 +150,3 @@ class RosterItem(ElementBase):
register_stanza_plugin(Iq, Roster) register_stanza_plugin(Iq, Roster)
register_stanza_plugin(Roster, RosterItem, iterable=True) register_stanza_plugin(Roster, RosterItem, iterable=True)
# To comply with PEP8, method names now use underscores.
# Deprecated method names are re-mapped for backwards compatibility.
Roster.setItems = Roster.set_items
Roster.getItems = Roster.get_items
Roster.delItems = Roster.del_items

5
slixmpp/xmlstream/handler/base.py
View File

@ -77,8 +77,3 @@ class BaseHandler(object):
of stream handlers. of stream handlers.
""" """
return self._destroy return self._destroy
# To comply with PEP8, method names now use underscores.
# Deprecated method names are re-mapped for backwards compatibility.
BaseHandler.checkDelete = BaseHandler.check_delete

26
slixmpp/xmlstream/stanzabase.py
View File

@ -91,10 +91,6 @@ def register_stanza_plugin(stanza, plugin, iterable=False, overrides=False):
stanza.plugin_overrides[interface] = plugin.plugin_attrib stanza.plugin_overrides[interface] = plugin.plugin_attrib
# To maintain backwards compatibility for now, preserve the camel case name.
registerStanzaPlugin = register_stanza_plugin
def multifactory(stanza, plugin_attrib): def multifactory(stanza, plugin_attrib):
""" """
Returns a ElementBase class for handling reoccuring child stanzas Returns a ElementBase class for handling reoccuring child stanzas
@ -1620,25 +1616,3 @@ class StanzaBase(ElementBase):
#: Child stanzas are exposed as nested dictionaries. #: Child stanzas are exposed as nested dictionaries.
ElementBase.values = property(ElementBase._get_stanza_values, ElementBase.values = property(ElementBase._get_stanza_values,
ElementBase._set_stanza_values) ElementBase._set_stanza_values)
# To comply with PEP8, method names now use underscores.
# Deprecated method names are re-mapped for backwards compatibility.
ElementBase.initPlugin = ElementBase.init_plugin
ElementBase._getAttr = ElementBase._get_attr
ElementBase._setAttr = ElementBase._set_attr
ElementBase._delAttr = ElementBase._del_attr
ElementBase._getSubText = ElementBase._get_sub_text
ElementBase._setSubText = ElementBase._set_sub_text
ElementBase._delSub = ElementBase._del_sub
ElementBase.getStanzaValues = ElementBase._get_stanza_values
ElementBase.setStanzaValues = ElementBase._set_stanza_values
StanzaBase.setType = StanzaBase.set_type
StanzaBase.getTo = StanzaBase.get_to
StanzaBase.setTo = StanzaBase.set_to
StanzaBase.getFrom = StanzaBase.get_from
StanzaBase.setFrom = StanzaBase.set_from
StanzaBase.getPayload = StanzaBase.get_payload
StanzaBase.setPayload = StanzaBase.set_payload
StanzaBase.delPayload = StanzaBase.del_payload

14
tests/test_stanza_element.py
View File

@ -38,7 +38,7 @@ class TestElementBase(SlixTest):
""") """)
def testGetStanzaValues(self): def testGetStanzaValues(self):
"""Test getStanzaValues using plugins and substanzas.""" """Test get_stanza_values using plugins and substanzas."""
class TestStanzaPlugin(ElementBase): class TestStanzaPlugin(ElementBase):
name = "foo2" name = "foo2"
@ -65,7 +65,7 @@ class TestElementBase(SlixTest):
substanza['bar'] = 'c' substanza['bar'] = 'c'
stanza.append(substanza) stanza.append(substanza)
values = stanza.getStanzaValues() values = stanza.get_stanza_values()
expected = {'lang': '', expected = {'lang': '',
'bar': 'a', 'bar': 'a',
'baz': '', 'baz': '',
@ -85,7 +85,7 @@ class TestElementBase(SlixTest):
def testSetStanzaValues(self): def testSetStanzaValues(self):
"""Test using setStanzaValues with substanzas and plugins.""" """Test using set_stanza_values with substanzas and plugins."""
class TestStanzaPlugin(ElementBase): class TestStanzaPlugin(ElementBase):
name = "pluginfoo" name = "pluginfoo"
@ -157,10 +157,10 @@ class TestElementBase(SlixTest):
stanza = TestStanza() stanza = TestStanza()
substanza = TestStanza() substanza = TestStanza()
stanza.append(substanza) stanza.append(substanza)
stanza.setStanzaValues({'bar': 'a', stanza.set_stanza_values({'bar': 'a',
'baz': 'b', 'baz': 'b',
'qux': 42, 'qux': 42,
'foobar': {'fizz': 'c'}}) 'foobar': {'fizz': 'c'}})
# Test non-plugin interfaces # Test non-plugin interfaces
expected = {'substanzas': [substanza], expected = {'substanzas': [substanza],

2
tests/test_stanza_iq.py
View File

@ -19,7 +19,7 @@ class TestIqStanzas(SlixTest):
def testPayload(self): def testPayload(self):
"""Test setting Iq stanza payload.""" """Test setting Iq stanza payload."""
iq = self.Iq() iq = self.Iq()
iq.setPayload(ET.Element('{test}tester')) iq.set_payload(ET.Element('{test}tester'))
self.check(iq, """ self.check(iq, """
<iq id="0"> <iq id="0">
<tester xmlns="test" /> <tester xmlns="test" />

2
tests/test_stanza_roster.py
View File

@ -8,7 +8,7 @@ class TestRosterStanzas(SlixTest):
def testAddItems(self): def testAddItems(self):
"""Test adding items to a roster stanza.""" """Test adding items to a roster stanza."""
iq = self.Iq() iq = self.Iq()
iq['roster'].setItems({ iq['roster'].set_items({
'user@example.com': { 'user@example.com': {
'name': 'User', 'name': 'User',
'subscription': 'both', 'subscription': 'both',