Add annotations to modules/util.py

This commit is contained in:
Philipp Hörist 2018-09-11 00:28:46 +02:00
parent ca9b4cb596
commit 2649b3d01e
1 changed files with 14 additions and 9 deletions

View File

@ -14,12 +14,15 @@
# Util module # Util module
from typing import Union
import nbxmpp import nbxmpp
from gajim.common import app from gajim.common import app
def is_self_message(message, groupchat=False): def is_self_message(message: nbxmpp.Node,
groupchat: bool = False) -> bool:
if groupchat: if groupchat:
return False return False
frm = message.getFrom() frm = message.getFrom()
@ -27,7 +30,9 @@ def is_self_message(message, groupchat=False):
return frm.bareMatch(to) return frm.bareMatch(to)
def is_muc_pm(message, jid, groupchat=False): def is_muc_pm(message: nbxmpp.Node,
jid: nbxmpp.JID,
groupchat: bool = False) -> bool:
if groupchat: if groupchat:
return False return False
muc_user = message.getTag('x', namespace=nbxmpp.NS_MUC_USER) muc_user = message.getTag('x', namespace=nbxmpp.NS_MUC_USER)
@ -41,10 +46,10 @@ def is_muc_pm(message, jid, groupchat=False):
return False return False
def from_xs_boolean(value): def from_xs_boolean(value: Union[str, bool]) -> bool:
# Convert a xs:boolean ('true', 'false', '1', '0', '') # Convert a xs:boolean ('true', 'false', '1', '0', '')
# to a python boolean (True, False) # to a python boolean (True, False)
if value in (True, False): if isinstance(value, bool):
return value return value
if value in ('1', 'true'): if value in ('1', 'true'):
@ -58,16 +63,16 @@ def from_xs_boolean(value):
'Cant convert %s to python boolean' % value) 'Cant convert %s to python boolean' % value)
def to_xs_boolean(value): def to_xs_boolean(value: Union[bool, None]) -> str:
# Convert to xs:boolean ('true', 'false') # Convert to xs:boolean ('true', 'false')
# from a python boolean (True, False) or None # from a python boolean (True, False) or None
if value in ('true', 'false'):
return value
if value is True: if value is True:
return 'true' return 'true'
if value in (False, None): if value is False:
return 'false'
if value is None:
return 'false' return 'false'
raise ValueError( raise ValueError(