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_0152/reachability.py | |
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_0152/reachability.py')
-rw-r--r-- | slixmpp/plugins/xep_0152/reachability.py | 38 |
1 files changed, 16 insertions, 22 deletions
diff --git a/slixmpp/plugins/xep_0152/reachability.py b/slixmpp/plugins/xep_0152/reachability.py index 3ff5e118..0ca0ae68 100644 --- a/slixmpp/plugins/xep_0152/reachability.py +++ b/slixmpp/plugins/xep_0152/reachability.py @@ -8,8 +8,11 @@ import logging +from slixmpp import JID +from typing import Dict, List, Optional, Callable from slixmpp.plugins.base import BasePlugin from slixmpp.plugins.xep_0152 import stanza, Reachability +from slixmpp.plugins.xep_0004 import Form log = logging.getLogger(__name__) @@ -33,22 +36,18 @@ class XEP_0152(BasePlugin): def session_bind(self, jid): self.xmpp['xep_0163'].register_pep('reachability', Reachability) - def publish_reachability(self, addresses, options=None, ifrom=None, - callback=None, timeout=None, - timeout_callback=None): + def publish_reachability(self, addresses: List[Dict[str, str]], + options: Optional[Form] = None, + ifrom: Optional[JID] = None, + callback: Optional[Callable] = None, + timeout: Optional[int] = None, + timeout_callback: Optional[Callable] = None): """ Publish alternative addresses where the user can be reached. - Arguments: - addresses -- A list of dictionaries containing the URI and - optional description for each address. - 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 addresses: A list of dictionaries containing the URI and + optional description for each address. + :param options: Optional form of publish options. """ if not isinstance(addresses, (list, tuple)): addresses = [addresses] @@ -69,17 +68,12 @@ class XEP_0152(BasePlugin): timeout=timeout, timeout_callback=timeout_callback) - def stop(self, ifrom=None, callback=None, timeout=None, timeout_callback=None): + def stop(self, ifrom: Optional[JID] = None, + callback: Optional[Callable] = None, + timeout: Optional[int] = None, + timeout_callback: Optional[Callable] = None): """ Clear existing user activity 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. """ reach = Reachability() return self.xmpp['xep_0163'].publish(reach, |