diff options
| author | Lance Stout <lancestout@gmail.com> | 2010-08-03 18:32:53 -0400 |
|---|---|---|
| committer | Lance Stout <lancestout@gmail.com> | 2010-08-03 18:32:53 -0400 |
| commit | fec69be7318d9ad2a8e4ac128ac57f1969a6b852 (patch) | |
| tree | b5157e3feb9f5f012c7f140a04d1664c5baedec3 /sleekxmpp/stanza/nick.py | |
| parent | 956fdf69709af8f59b92c0fe5e77490f2c670648 (diff) | |
| download | slixmpp-fec69be7318d9ad2a8e4ac128ac57f1969a6b852.tar.gz slixmpp-fec69be7318d9ad2a8e4ac128ac57f1969a6b852.tar.bz2 slixmpp-fec69be7318d9ad2a8e4ac128ac57f1969a6b852.tar.xz slixmpp-fec69be7318d9ad2a8e4ac128ac57f1969a6b852.zip | |
Update nick stanza with documentation and PEP8 style.
Diffstat (limited to 'sleekxmpp/stanza/nick.py')
| -rw-r--r-- | sleekxmpp/stanza/nick.py | 80 |
1 files changed, 63 insertions, 17 deletions
diff --git a/sleekxmpp/stanza/nick.py b/sleekxmpp/stanza/nick.py index 47d4620a..de54b307 100644 --- a/sleekxmpp/stanza/nick.py +++ b/sleekxmpp/stanza/nick.py @@ -5,22 +5,68 @@ See the file LICENSE for copying permission. """ -from .. xmlstream.stanzabase import registerStanzaPlugin, ElementBase, ET + +from sleekxmpp.stanza import Message, Presence +from sleekxmpp.xmlstream.stanzabase import registerStanzaPlugin +from sleekxmpp.xmlstream.stanzabase import ElementBase, ET + class Nick(ElementBase): - namespace = 'http://jabber.org/nick/nick' - name = 'nick' - plugin_attrib = 'nick' - interfaces = set(('nick')) - plugin_attrib_map = set() - plugin_xml_map = set() - - def setNick(self, nick): - self.xml.text = nick - - def getNick(self): - return self.xml.text - - def delNick(self): - if self.parent is not None: - self.parent().xml.remove(self.xml) + + """ + XEP-0172: User Nickname allows the addition of a <nick> element + in several stanza types, including <message> and <presence> stanzas. + + The nickname contained in a <nick> should be the global, friendly or + informal name chosen by the owner of a bare JID. The <nick> element + may be included when establishing communications with new entities, + such as normal XMPP users or MUC services. + + The nickname contained in a <nick> element will not necessarily be + the same as the nickname used in a MUC. + + Example stanzas: + <message to="user@example.com"> + <nick xmlns="http://jabber.org/nick/nick">The User</nick> + <body>...</body> + </message> + + <presence to="otheruser@example.com" type="subscribe"> + <nick xmlns="http://jabber.org/nick/nick">The User</nick> + </presence> + + Stanza Interface: + nick -- A global, friendly or informal name chosen by a user. + + Methods: + getNick -- Return the nickname in the <nick> element. + setNick -- Add a <nick> element with the given nickname. + delNick -- Remove the <nick> element. + """ + + namespace = 'http://jabber.org/nick/nick' + name = 'nick' + plugin_attrib = name + interfaces = set(('nick',)) + + def setNick(self, nick): + """ + Add a <nick> element with the given nickname. + + Arguments: + nick -- A human readable, informal name. + """ + self.xml.text = nick + + def getNick(self): + """Return the nickname in the <nick> element.""" + return self.xml.text + + def delNick(self): + """Remove the <nick> element.""" + if self.parent is not None: + self.parent().xml.remove(self.xml) + + +registerStanzaPlugin(Message, Nick) +registerStanzaPlugin(Presence, Nick) |