Skip to content

Include the received type for SignatureBodyMismatchErrors #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
acrisci merged 2 commits into from
May 2, 2020
Merged

Include the received type for SignatureBodyMismatchErrors #46

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18241d7
Include the received type for SignatureBodyMismatchErrors
rytilahti May 1, 2020
c726bad
Add missing space
rytilahti May 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 31 additions & 18 deletions dbus_next/signature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,20 +100,23 @@ def _verify_byte(self, body):
BYTE_MIN = 0x00
BYTE_MAX = 0xff
if not isinstance(body, int):
raise SignatureBodyMismatchError('DBus BYTE type "y" must be Python type "int"')
raise SignatureBodyMismatchError(
f'DBus BYTE type "y" must be Python type "int", got {type(body)}')
if body < BYTE_MIN or body > BYTE_MAX:
raise SignatureBodyMismatchError(
f'DBus BYTE type must be between {BYTE_MIN} and {BYTE_MAX}')

def _verify_boolean(self, body):
if not isinstance(body, bool):
raise SignatureBodyMismatchError('DBus BOOLEAN type "b" must be Python type "bool"')
raise SignatureBodyMismatchError(
f'DBus BOOLEAN type "b" must be Python type "bool", got {type(body)}')

def _verify_int16(self, body):
INT16_MIN = -0x7fff - 1
INT16_MAX = 0x7fff
if not isinstance(body, int):
raise SignatureBodyMismatchError('DBus INT16 type "n" must be Python type "int"')
raise SignatureBodyMismatchError(
f'DBus INT16 type "n" must be Python type "int", got {type(body)}')
elif body > INT16_MAX or body < INT16_MIN:
raise SignatureBodyMismatchError(
f'DBus INT16 type "n" must be between {INT16_MIN} and {INT16_MAX}')
Expand All @@ -122,7 +125,8 @@ def _verify_uint16(self, body):
UINT16_MIN = 0
UINT16_MAX = 0xffff
if not isinstance(body, int):
raise SignatureBodyMismatchError('DBus UINT16 type "q" must be Python type "int"')
raise SignatureBodyMismatchError(
f'DBus UINT16 type "q" must be Python type "int", got {type(body)}')
elif body > UINT16_MAX or body < UINT16_MIN:
raise SignatureBodyMismatchError(
f'DBus UINT16 type "q" must be between {UINT16_MIN} and {UINT16_MAX}')
Expand All @@ -131,7 +135,8 @@ def _verify_int32(self, body):
INT32_MIN = -0x7fffffff - 1
INT32_MAX = 0x7fffffff
if not isinstance(body, int):
raise SignatureBodyMismatchError('DBus INT32 type "i" must be Python type "int"')
raise SignatureBodyMismatchError(
f'DBus INT32 type "i" must be Python type "int", got {type(body)}')
elif body > INT32_MAX or body < INT32_MIN:
raise SignatureBodyMismatchError(
f'DBus INT32 type "i" must be between {INT32_MIN} and {INT32_MAX}')
Expand All @@ -140,7 +145,8 @@ def _verify_uint32(self, body):
UINT32_MIN = 0
UINT32_MAX = 0xffffffff
if not isinstance(body, int):
raise SignatureBodyMismatchError('DBus UINT32 type "u" must be Python type "int"')
raise SignatureBodyMismatchError(
f'DBus UINT32 type "u" must be Python type "int", got {type(body)}')
elif body > UINT32_MAX or body < UINT32_MIN:
raise SignatureBodyMismatchError(
f'DBus UINT32 type "u" must be between {UINT32_MIN} and {UINT32_MAX}')
Expand All @@ -149,7 +155,8 @@ def _verify_int64(self, body):
INT64_MAX = 9223372036854775807
INT64_MIN = -INT64_MAX - 1
if not isinstance(body, int):
raise SignatureBodyMismatchError('DBus INT64 type "x" must be Python type "int"')
raise SignatureBodyMismatchError(
f'DBus INT64 type "x" must be Python type "int", got {type(body)}')
elif body > INT64_MAX or body < INT64_MIN:
raise SignatureBodyMismatchError(
f'DBus INT64 type "x" must be between {INT64_MIN} and {INT64_MAX}')
Expand All @@ -158,15 +165,16 @@ def _verify_uint64(self, body):
UINT64_MIN = 0
UINT64_MAX = 18446744073709551615
if not isinstance(body, int):
raise SignatureBodyMismatchError('DBus UINT64 type "t" must be Python type "int"')
raise SignatureBodyMismatchError(
f'DBus UINT64 type "t" must be Python type "int", got {type(body)}')
elif body > UINT64_MAX or body < UINT64_MIN:
raise SignatureBodyMismatchError(
f'DBus UINT64 type "t" must be between {UINT64_MIN} and {UINT64_MAX}')

def _verify_double(self, body):
if not isinstance(body, float) and not isinstance(body, int):
raise SignatureBodyMismatchError(
'DBus DOUBLE type "d" must be Python type "float" or "int"')
f'DBus DOUBLE type "d" must be Python type "float" or "int", got {type(body)}')

def _verify_unix_fd(self, body):
try:
Expand All @@ -181,12 +189,14 @@ def _verify_object_path(self, body):

def _verify_string(self, body):
if not isinstance(body, str):
raise SignatureBodyMismatchError('DBus STRING type "s" must be Python type "str"')
raise SignatureBodyMismatchError(
f'DBus STRING type "s" must be Python type "str", got {type(body)}')

def _verify_signature(self, body):
# I guess we could run it through the SignatureTree parser instead
if not isinstance(body, str):
raise SignatureBodyMismatchError('DBus SIGNATURE type "g" must be Python type "str"')
raise SignatureBodyMismatchError(
f'DBus SIGNATURE type "g" must be Python type "str", got {type(body)}')
if len(body.encode()) > 0xff:
raise SignatureBodyMismatchError('DBus SIGNATURE type "g" must be less than 256 bytes')

Expand All @@ -196,25 +206,29 @@ def _verify_array(self, body):
if child_type.token == '{':
if not isinstance(body, dict):
raise SignatureBodyMismatchError(
'DBus ARRAY type "a" with DICT_ENTRY child must be Python type "dict"')
f'DBus ARRAY type "a" with DICT_ENTRY child must be Python type "dict", got {type(body)}'
)
for key, value in body.items():
child_type.children[0].verify(key)
child_type.children[1].verify(value)
elif child_type.token == 'y':
if not isinstance(body, bytes):
raise SignatureBodyMismatchError(
'DBus ARRAY type "a" with BYTE child must be Python type "bytes"')
f'DBus ARRAY type "a" with BYTE child must be Python type "bytes", got {type(body)}'
)
# no need to verify children
else:
if not isinstance(body, list):
raise SignatureBodyMismatchError('DBus ARRAY type "a" must be Python type "list"')
raise SignatureBodyMismatchError(
f'DBus ARRAY type "a" must be Python type "list", got {type(body)}')
for member in body:
child_type.verify(member)

def _verify_struct(self, body):
# TODO allow tuples
if not isinstance(body, list):
raise SignatureBodyMismatchError('DBus STRUCT type "(" must be Python type "list"')
raise SignatureBodyMismatchError(
f'DBus STRUCT type "(" must be Python type "list", got {type(body)}')

if len(body) != len(self.children):
raise SignatureBodyMismatchError(
Expand All @@ -227,7 +241,8 @@ def _verify_struct(self, body):
def _verify_variant(self, body):
# a variant signature and value is valid by construction
if not isinstance(body, Variant):
raise SignatureBodyMismatchError('DBus VARIANT type "v" must be Python type "Variant"')
raise SignatureBodyMismatchError(
f'DBus VARIANT type "v" must be Python type "Variant", got {type(body)}')

def verify(self, body: Any) -> bool:
"""Verify that the body matches this type.
Expand Down Expand Up @@ -291,7 +306,6 @@ class SignatureTree:
:raises:
:class:`InvalidSignatureError` if the given signature is not valid.
"""

def __init__(self, signature: str = ''):
self.signature = signature

Expand Down Expand Up @@ -353,7 +367,6 @@ class Variant:
:class:`InvalidSignatureError` if the signature is not valid.
:class:`SignatureBodyMismatchError` if the signature does not match the body.
"""

def __init__(self, signature: Union[str, SignatureTree, SignatureType], value: Any):
signature_str = ''
signature_tree = None
Expand Down