goodboy
/
tractor
1
0
Fork 2
Code Issues 3 Pull Requests 6 Packages Projects Releases Wiki Activity

Tweak type-error messages for when `ext_types` is missing

ext_type_plds
Tyler Goodlet 2025-03-08 15:48:18 -05:00
parent e40a76fe83
commit 6b65b9e4de
1 changed files with 33 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
tractor/msg/_codec.py
View File

@ -211,24 +211,28 @@ def mk_dec(
and and
ext_types is None ext_types is None
): ):
raise ValueError( raise TypeError(
f'You must provide a type-spec for a msg decoder!\n' f'MIssing type-`spec` for msg decoder!\n'
f'The only time `spec=None` is permitted is if custom extension types ' f'\n'
f'are expected to be supported, in which case `ext_types` must be non-`None`' f'`spec=None` is **only** permitted is if custom extension types '
f'and it is presumed that only the `ext_types` (supported by the paired `dec_hook()`) ' f'are provided via `ext_types`, meaning it must be non-`None`.\n'
f'will be permitted within the type-`spec`!\n' f'\n'
f'In this case it is presumed that only the `ext_types`, '
f'tpec = {spec!r}\n' f'which much be handled by a paired `dec_hook()`, '
f'will be permitted within the payload type-`spec`!\n'
f'\n'
f'spec = {spec!r}\n'
f'dec_hook = {dec_hook!r}\n' f'dec_hook = {dec_hook!r}\n'
f'ext_types = {ext_types!r}\n' f'ext_types = {ext_types!r}\n'
) )
if dec_hook: if dec_hook:
if ext_types is None: if ext_types is None:
raise ValueError( raise TypeError(
f'If extending the serializable types with a custom decoder hook, ' f'If extending the serializable types with a custom decode hook (`dec_hook()`), '
f'you must also provide the expected type set `dec_hook()` will handle ' f'you must also provide the expected type set that the hook will handle '
f'via the `ext_types: Union[Type]|None = None` argument!\n' f'via a `ext_types: Union[Type]|None = None` argument!\n'
f'\n'
f'dec_hook = {dec_hook!r}\n' f'dec_hook = {dec_hook!r}\n'
f'ext_types = {ext_types!r}\n' f'ext_types = {ext_types!r}\n'
) )
@ -287,7 +291,7 @@ def unpack_spec_types(
When `spec` is not a type-union returns `{spec,}`. When `spec` is not a type-union returns `{spec,}`.
''' '''
spec_subtypes: set[Union[Type]] = ( spec_subtypes: set[Union[Type]] = set(
getattr( getattr(
spec, spec,
'__args__', '__args__',
@ -449,6 +453,7 @@ class MsgCodec(Struct):
# |_BufferError: Existing exports of data: object cannot be re-sized # |_BufferError: Existing exports of data: object cannot be re-sized
as_ext_type: bool = False, as_ext_type: bool = False,
hide_tb: bool = True,
) -> bytes: ) -> bytes:
''' '''
@ -459,11 +464,21 @@ class MsgCodec(Struct):
https://jcristharif.com/msgspec/perf-tips.html#reusing-an-output-buffer https://jcristharif.com/msgspec/perf-tips.html#reusing-an-output-buffer
''' '''
__tracebackhide__: bool = hide_tb
if use_buf: if use_buf:
self._enc.encode_into(py_obj, self._buf) self._enc.encode_into(py_obj, self._buf)
return self._buf return self._buf
return self._enc.encode(py_obj) return self._enc.encode(py_obj)
# try:
# return self._enc.encode(py_obj)
# except TypeError as typerr:
# typerr.add_note(
# '|_src error from `msgspec`'
# # f'|_{self._enc.encode!r}'
# )
# raise typerr
# TODO! REMOVE once i'm confident we won't ever need it! # TODO! REMOVE once i'm confident we won't ever need it!
# #
# box: Struct = self._ext_types_box # box: Struct = self._ext_types_box
@ -572,10 +587,11 @@ def mk_codec(
pld_spec = ipc_pld_spec pld_spec = ipc_pld_spec
if enc_hook: if enc_hook:
if not ext_types: if not ext_types:
raise ValueError( raise TypeError(
f'If extending the serializable types with a custom decoder hook, ' f'If extending the serializable types with a custom encode hook (`enc_hook()`), '
f'you must also provide the expected type set `enc_hook()` will handle ' f'you must also provide the expected type set that the hook will handle '
f'via the `ext_types: Union[Type]|None = None` argument!\n' f'via a `ext_types: Union[Type]|None = None` argument!\n'
f'\n'
f'enc_hook = {enc_hook!r}\n' f'enc_hook = {enc_hook!r}\n'
f'ext_types = {ext_types!r}\n' f'ext_types = {ext_types!r}\n'
) )