diff options
| author | mathieui <mathieui@mathieui.net> | 2020-12-10 19:20:23 +0100 |
|---|---|---|
| committer | mathieui <mathieui@mathieui.net> | 2020-12-10 19:22:40 +0100 |
| commit | 95d40a3ca336a4e1b66c7ed287ec3f2ef92b201c (patch) | |
| tree | ef3086be7313a8e61e51b7a3efed302d0e154cb0 /slixmpp/plugins/xep_0172 | |
| parent | 010bf6dd70a44d9e9087336bc955a591ab9248b3 (diff) | |
| download | slixmpp-95d40a3ca336a4e1b66c7ed287ec3f2ef92b201c.tar.gz slixmpp-95d40a3ca336a4e1b66c7ed287ec3f2ef92b201c.tar.bz2 slixmpp-95d40a3ca336a4e1b66c7ed287ec3f2ef92b201c.tar.xz slixmpp-95d40a3ca336a4e1b66c7ed287ec3f2ef92b201c.zip | |
docs: update docstrings for sphinx conformity
Remove most references to timeout/callback/ifrom/timeout_callbacks args
Diffstat (limited to 'slixmpp/plugins/xep_0172')
| -rw-r--r-- | slixmpp/plugins/xep_0172/stanza.py | 11 | ||||
| -rw-r--r-- | slixmpp/plugins/xep_0172/user_nick.py | 35 |
2 files changed, 21 insertions, 25 deletions
diff --git a/slixmpp/plugins/xep_0172/stanza.py b/slixmpp/plugins/xep_0172/stanza.py index c85137ab..addba94a 100644 --- a/slixmpp/plugins/xep_0172/stanza.py +++ b/slixmpp/plugins/xep_0172/stanza.py @@ -24,6 +24,9 @@ class UserNick(ElementBase): 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> @@ -34,13 +37,11 @@ class UserNick(ElementBase): </presence> Stanza Interface: + + :: + nick -- A global, friendly or informal name chosen by a user. - Methods: - setup -- Overrides ElementBase.setup. - get_nick -- Return the nickname in the <nick> element. - set_nick -- Add a <nick> element with the given nickname. - del_nick -- Remove the <nick> element. """ namespace = 'http://jabber.org/protocol/nick' diff --git a/slixmpp/plugins/xep_0172/user_nick.py b/slixmpp/plugins/xep_0172/user_nick.py index 0bba8611..ef96c51a 100644 --- a/slixmpp/plugins/xep_0172/user_nick.py +++ b/slixmpp/plugins/xep_0172/user_nick.py @@ -8,6 +8,8 @@ import logging +from typing import Optional, Callable +from slixmpp import JID from slixmpp.stanza.message import Message from slixmpp.stanza.presence import Presence from slixmpp.xmlstream import register_stanza_plugin @@ -15,6 +17,7 @@ from slixmpp.xmlstream.handler import Callback from slixmpp.xmlstream.matcher import MatchXPath from slixmpp.plugins.base import BasePlugin from slixmpp.plugins.xep_0172 import stanza, UserNick +from slixmpp.plugins.xep_0004.stanza import Form log = logging.getLogger(__name__) @@ -42,20 +45,17 @@ class XEP_0172(BasePlugin): def session_bind(self, jid): self.xmpp['xep_0163'].register_pep('user_nick', UserNick) - def publish_nick(self, nick=None, options=None, ifrom=None, timeout_callback=None, - callback=None, timeout=None): + def publish_nick(self, nick: Optional[str] = None, + options: Optional[Form] = None, + ifrom: Optional[JID] = None, + timeout_callback: Optional[Callable] = None, + callback: Optional[Callable] = None, + timeout: Optional[int] = None): """ Publish the user's current nick. - Arguments: - nick -- The user nickname to publish. - options -- Optional form of publish options. - ifrom -- Specify the sender's JID. - timeout -- The length of time (in seconds) to wait for a response - before exiting the send call if blocking is used. - Defaults to slixmpp.xmlstream.RESPONSE_TIMEOUT - callback -- Optional reference to a stream handler function. Will - be executed when a reply stanza is received. + :param nick: The user nickname to publish. + :param options: Optional form of publish options. """ nickname = UserNick() nickname['nick'] = nick @@ -64,17 +64,12 @@ class XEP_0172(BasePlugin): callback=callback, timeout=timeout, timeout_callback=timeout_callback) - def stop(self, ifrom=None, timeout_callback=None, callback=None, timeout=None): + def stop(self, ifrom: Optional[JID] = None, + timeout_callback: Optional[Callable] = None, + callback: Optional[Callable] = None, + timeout: Optional[int] = None): """ Clear existing user nick information to stop notifications. - - Arguments: - ifrom -- Specify the sender's JID. - timeout -- The length of time (in seconds) to wait for a response - before exiting the send call if blocking is used. - Defaults to slixmpp.xmlstream.RESPONSE_TIMEOUT - callback -- Optional reference to a stream handler function. Will - be executed when a reply stanza is received. """ nick = UserNick() return self.xmpp['xep_0163'].publish(nick, node=UserNick.namespace, |