summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2021-02-04 20:35:22 +0100
committermathieui <mathieui@mathieui.net>2021-02-04 20:35:22 +0100
commitfbb899324495ff76400815b91649436ca75474f2 (patch)
tree8840b19d97f73c0e6ee6e513c179635eac59469e
parent77c8caf20557b17296896544a3414164696523ef (diff)
downloadslixmpp-fbb899324495ff76400815b91649436ca75474f2.tar.gz
slixmpp-fbb899324495ff76400815b91649436ca75474f2.tar.bz2
slixmpp-fbb899324495ff76400815b91649436ca75474f2.tar.xz
slixmpp-fbb899324495ff76400815b91649436ca75474f2.zip
XEP-0049: Add type hints and switch to default args
-rw-r--r--slixmpp/plugins/xep_0049/private_storage.py42
1 files changed, 24 insertions, 18 deletions
diff --git a/slixmpp/plugins/xep_0049/private_storage.py b/slixmpp/plugins/xep_0049/private_storage.py
index cb92db51..22286f92 100644
--- a/slixmpp/plugins/xep_0049/private_storage.py
+++ b/slixmpp/plugins/xep_0049/private_storage.py
@@ -7,12 +7,19 @@
"""
import logging
-
-from slixmpp import Iq
+from typing import (
+ List,
+ Optional,
+ Union,
+)
+from asyncio import Future
+
+from slixmpp import JID
+from slixmpp.stanza import Iq
from slixmpp.plugins import BasePlugin
from slixmpp.xmlstream.handler import Callback
from slixmpp.xmlstream.matcher import StanzaPath
-from slixmpp.xmlstream import register_stanza_plugin
+from slixmpp.xmlstream import register_stanza_plugin, ElementBase
from slixmpp.plugins.xep_0049 import stanza, PrivateXML
@@ -32,26 +39,25 @@ class XEP_0049(BasePlugin):
def register(self, stanza):
register_stanza_plugin(PrivateXML, stanza, iterable=True)
- def store(self, data, ifrom=None, timeout=None, callback=None,
- timeout_callback=None):
- iq = self.xmpp.Iq()
- iq['type'] = 'set'
- iq['from'] = ifrom
+ def store(self, data: Union[List[ElementBase], ElementBase], ifrom: Optional[JID] = None, **iqkwargs) -> Future:
+ """Store data in Private XML Storage.
+
+ :param data: An XML element or list of xml element to store.
+ """
+ iq = self.xmpp.make_iq_set(ifrom=ifrom)
if not isinstance(data, list):
data = [data]
-
for elem in data:
iq['private'].append(elem)
- return iq.send(timeout=timeout, callback=callback,
- timeout_callback=timeout_callback)
+ return iq.send(**iqkwargs)
+
+ def retrieve(self, name: str, ifrom: Optional[JID] = None, **iqkwargs) -> Future:
+ """Get previously stored data from Private XML Storage.
- def retrieve(self, name, ifrom=None, timeout=None, callback=None,
- timeout_callback=None):
- iq = self.xmpp.Iq()
- iq['type'] = 'get'
- iq['from'] = ifrom
+ :param name: Name of the payload to retrieve (slixmpp plugin attribute)
+ """
+ iq = self.xmpp.make_iq_get(ifrom=ifrom)
iq['private'].enable(name)
- return iq.send(timeout=timeout, callback=callback,
- timeout_callback=timeout_callback)
+ return iq.send(**iqkwargs)