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

notes on the usefulness of some of the 'makeIq' methods. In particular, they seem to duplicate behavior or be largely unused for their intended purpose.

Browse Source
This commit is contained in:
Tom Nichols 2010-07-07 15:06:39 -04:00
parent 34eb88f199
commit f7273affc5
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
sleekxmpp/basexmpp.py
View File

@ -159,34 +159,48 @@ class basexmpp(object):
return waitfor.wait(timeout) return waitfor.wait(timeout)
def makeIq(self, id=0, ifrom=None): def makeIq(self, id=0, ifrom=None):
# FIXME this will always assign an ID of 0 instead of allowing `getNewId`
# to assign a unique ID to the new IQ packet. This method is only called
# from xep_0199 and should probably be deprecated.
return self.Iq().setValues({'id': id, 'from': ifrom}) return self.Iq().setValues({'id': id, 'from': ifrom})
def makeIqGet(self, queryxmlns = None): def makeIqGet(self, queryxmlns = None):
# TODO this should take a 'to' param since more often than not you set
# iq['to']=whatever immediately after.
iq = self.Iq().setValues({'type': 'get'}) iq = self.Iq().setValues({'type': 'get'})
if queryxmlns: if queryxmlns:
iq.append(ET.Element("{%s}query" % queryxmlns)) iq.append(ET.Element("{%s}query" % queryxmlns))
return iq return iq
def makeIqResult(self, id): def makeIqResult(self, id):
# TODO this should take a 'to' param since more often than not you set
# iq['to']=whatever immediately after.
return self.Iq().setValues({'id': id, 'type': 'result'}) return self.Iq().setValues({'id': id, 'type': 'result'})
def makeIqSet(self, sub=None): def makeIqSet(self, sub=None):
# TODO this should take a 'to' param since more often than not you set
# iq['to']=whatever immediately after.
iq = self.Iq().setValues({'type': 'set'}) iq = self.Iq().setValues({'type': 'set'})
if sub != None: if sub != None:
iq.append(sub) iq.append(sub)
return iq return iq
def makeIqError(self, id, type='cancel', condition='feature-not-implemented', text=None): def makeIqError(self, id, type='cancel', condition='feature-not-implemented', text=None):
# TODO not used.
iq = self.Iq().setValues({'id': id}) iq = self.Iq().setValues({'id': id})
iq['error'].setValues({'type': type, 'condition': condition, 'text': text}) iq['error'].setValues({'type': type, 'condition': condition, 'text': text})
return iq return iq
def makeIqQuery(self, iq, xmlns): def makeIqQuery(self, iq, xmlns):
# FIXME this looks like it essentially duplicates the `makeIqGet`
# and is only used in xep_009 (in two places) and gmail_notify (once).
# Probably safe to deprecate and replace with `makeIqGet.`
query = ET.Element("{%s}query" % xmlns) query = ET.Element("{%s}query" % xmlns)
iq.append(query) iq.append(query)
return iq return iq
def makeQueryRoster(self, iq=None): def makeQueryRoster(self, iq=None):
# FIXME unused. Remove; any user of this code can replace it by `makeIqGet('jabber:iq:roster')`
query = ET.Element("{jabber:iq:roster}query") query = ET.Element("{jabber:iq:roster}query")
if iq: if iq:
iq.append(query) iq.append(query)