diff options
author | mathieui <mathieui@mathieui.net> | 2021-02-04 21:01:35 +0100 |
---|---|---|
committer | mathieui <mathieui@mathieui.net> | 2021-02-05 20:08:16 +0100 |
commit | 7860edefe9dfb34815433cacdb239d9180a92be8 (patch) | |
tree | e8fed90d1f166255116506bc69d7dab790e2fedc | |
parent | fbb899324495ff76400815b91649436ca75474f2 (diff) | |
download | slixmpp-7860edefe9dfb34815433cacdb239d9180a92be8.tar.gz slixmpp-7860edefe9dfb34815433cacdb239d9180a92be8.tar.bz2 slixmpp-7860edefe9dfb34815433cacdb239d9180a92be8.tar.xz slixmpp-7860edefe9dfb34815433cacdb239d9180a92be8.zip |
XEP-0054: Add type hints and switch to default args
-rw-r--r-- | slixmpp/plugins/xep_0054/vcard_temp.py | 50 |
1 files changed, 30 insertions, 20 deletions
diff --git a/slixmpp/plugins/xep_0054/vcard_temp.py b/slixmpp/plugins/xep_0054/vcard_temp.py index 214746e9..12840052 100644 --- a/slixmpp/plugins/xep_0054/vcard_temp.py +++ b/slixmpp/plugins/xep_0054/vcard_temp.py @@ -7,8 +7,11 @@ """ import logging +from asyncio import Future +from typing import Optional -from slixmpp import JID, Iq +from slixmpp import JID +from slixmpp.stanza import Iq from slixmpp.exceptions import XMPPError from slixmpp.xmlstream import register_stanza_plugin from slixmpp.xmlstream.handler import Callback @@ -57,12 +60,22 @@ class XEP_0054(BasePlugin): def session_bind(self, jid): self.xmpp['xep_0030'].add_feature('vcard-temp') - def make_vcard(self): + def make_vcard(self) -> VCardTemp: + """Return an empty vcard element.""" return VCardTemp() @future_wrapper - def get_vcard(self, jid=None, ifrom=None, local=None, cached=False, - callback=None, timeout=None, timeout_callback=None): + def get_vcard(self, jid: Optional[JID] = None, *, + local: Optional[bool] = None, cached: bool = False, + ifrom: Optional[JID] = None, + **iqkwargs) -> Future: + """Retrieve a VCard. + + :param jid: JID of the entity to fetch the VCard from. + :param local: Only check internally for a vcard. + :param cached: Whether to check in the local cache before + sending a query. + """ if local is None: if jid is not None and not isinstance(jid, JID): jid = JID(jid) @@ -95,31 +108,28 @@ class XEP_0054(BasePlugin): return iq return vcard - iq = self.xmpp.Iq() - iq['to'] = jid - iq['from'] = ifrom - iq['type'] = 'get' + iq = self.xmpp.make_iq_get(ito=jid, ifrom=ifrom) iq.enable('vcard_temp') - - return iq.send(callback=callback, timeout=timeout, - timeout_callback=timeout_callback) + return iq.send(**iqkwargs) @future_wrapper - def publish_vcard(self, vcard=None, jid=None, ifrom=None, - callback=None, timeout=None, timeout_callback=None): + def publish_vcard(self, vcard: Optional[VCardTemp] = None, + jid: Optional[JID] = None, + ifrom: Optional[JID] = None, **iqkwargs) -> Future: + """Publish a vcard. + + :param vcard: The VCard to publish. + :param jid: The JID to publish the VCard to. + """ self.api['set_vcard'](jid, None, ifrom, vcard) if self.xmpp.is_component: return - iq = self.xmpp.Iq() - iq['to'] = jid - iq['from'] = ifrom - iq['type'] = 'set' + iq = self.xmpp.make_iq_set(ito=jid, ifrom=ifrom) iq.append(vcard) - return iq.send(callback=callback, timeout=timeout, - timeout_callback=timeout_callback) + return iq.send(**iqkwargs) - def _handle_get_vcard(self, iq): + def _handle_get_vcard(self, iq: Iq): if iq['type'] == 'result': self.api['set_vcard'](jid=iq['from'], args=iq['vcard_temp']) return |