XEP-0107: Fix return values and typing

This commit is contained in:
mathieui 2021-02-03 22:23:16 +01:00
parent 2585764b46
commit f2878e1764
2 changed files with 25 additions and 28 deletions

View file

@ -1,10 +1,7 @@
"""
Slixmpp: The Slick XMPP Library
Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout
This file is part of Slixmpp.
See the file LICENSE for copying permission.
"""
# Slixmpp: The Slick XMPP Library
# Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout
# This file is part of Slixmpp.
# See the file LICENSE for copying permission.
from slixmpp.xmlstream import ElementBase, ET

View file

@ -1,13 +1,15 @@
"""
Slixmpp: The Slick XMPP Library
Copyright (C) 2011 Nathanael C. Fritz, Lance J.T. Stout
This file is part of Slixmpp.
See the file LICENSE for copying permission.
"""
# Slixmpp: The Slick XMPP Library
# Copyright (C) 2011 Nathanael C. Fritz, Lance J.T. Stout
# This file is part of Slixmpp.
# See the file LICENSE for copying permission.
import logging
from asyncio import Future
from typing import (
Optional,
)
from slixmpp import Message
from slixmpp.xmlstream import register_stanza_plugin
from slixmpp.xmlstream.handler import Callback
@ -20,7 +22,6 @@ log = logging.getLogger(__name__)
class XEP_0107(BasePlugin):
"""
XEP-0107: User Mood
"""
@ -40,31 +41,30 @@ class XEP_0107(BasePlugin):
def session_bind(self, jid):
self.xmpp['xep_0163'].register_pep('user_mood', UserMood)
def publish_mood(self, value=None, text=None, options=None, ifrom=None,
callback=None, timeout=None, timeout_callback=None):
def publish_mood(self, value: Optional[str] = None, text: Optional[str] = None, **pubsubkwargs) -> Future:
"""
Publish the user's current mood.
:param value: The name of the mood to publish.
:param text: Optional natural-language description or reason
for the mood.
:param options: Optional form of publish options.
"""
mood = UserMood()
mood['value'] = value
mood['text'] = text
self.xmpp['xep_0163'].publish(mood, node=UserMood.namespace,
options=options, ifrom=ifrom,
callback=callback, timeout=timeout,
timeout_callback=timeout_callback)
return self.xmpp['xep_0163'].publish(
mood,
node=UserMood.namespace,
**pubsubkwargs
)
def stop(self, ifrom=None, callback=None, timeout=None,
timeout_callback=None):
def stop(self, **pubsubkwargs) -> Future:
"""
Clear existing user mood information to stop notifications.
"""
mood = UserMood()
self.xmpp['xep_0163'].publish(mood, node=UserMood.namespace,
ifrom=ifrom, callback=callback,
timeout=timeout,
timeout_callback=timeout_callback)
return self.xmpp['xep_0163'].publish(
mood,
node=UserMood.namespace,
**pubsubkwargs
)