Skip to content

Fix: GenConverter syntax errors with certain types #291

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.

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
merged 7 commits into from
Sep 18, 2022
Merged
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions HISTORY.rst
Original file line number Diff line number Diff line change
@@ -21,6 +21,7 @@ History
* Expose all error classes in the `cattr.errors` namespace. Note that it is deprecated, just use `cattrs.errors`. (`#252 <https://github.com/python-attrs/cattrs/issues/252>`_)
* ``cattrs.Converter`` and ``cattrs.BaseConverter`` can now copy themselves using the ``copy`` method.
(`#284 <https://github.com/python-attrs/cattrs/pull/284>`_)
* Fix generating structuring functions for types with quotes in the name. (`#291 <https://github.com/python-attrs/cattrs/issues/291>`_ `#277 <https://github.com/python-attrs/cattrs/issues/277>`_)

22.1.0 (2022-04-03)
-------------------
8 changes: 4 additions & 4 deletions src/cattrs/gen.py
Original file line number Diff line number Diff line change
@@ -340,7 +340,7 @@ def make_dict_structure_fn(
lines.append(f"{i}except Exception as e:")
i = f"{i} "
lines.append(
f"{i}e.__note__ = 'Structuring class {cl.__qualname__} @ attribute {an}'"
f"{i}e.__note__ = 'Structuring class ' + {cl.__qualname__!r} + ' @ attribute {an}'"
)
lines.append(f"{i}errors.append(e)")

@@ -352,15 +352,15 @@ def make_dict_structure_fn(
]

post_lines.append(
f" if errors: raise __c_cve('While structuring {cl.__name__}', errors, __cl)"
f" if errors: raise __c_cve('While structuring ' + {cl.__name__!r}, errors, __cl)"
)
instantiation_lines = (
[" try:"]
+ [" return __cl("]
+ [f" {line}" for line in invocation_lines]
+ [" )"]
+ [
f" except Exception as exc: raise __c_cve('While structuring {cl.__name__}', [exc], __cl)"
f" except Exception as exc: raise __c_cve('While structuring ' + {cl.__name__!r}, [exc], __cl)"
]
)
else:
@@ -717,7 +717,7 @@ def make_mapping_structure_fn(
lines.append(" errors.append(e)")
lines.append(" if errors:")
lines.append(
f" raise IterableValidationError('While structuring {cl!r}', errors, __cattr_mapping_cl)"
f" raise IterableValidationError('While structuring ' + {repr(cl)!r}, errors, __cattr_mapping_cl)"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might look odd at first glance - the first repr() gets a string representation of the class and the second repr (!r) turns said string into a string literal

)
else:
lines.append(f" res = {{{k_s}: {v_s} for k, v in mapping.items()}}")
21 changes: 19 additions & 2 deletions tests/test_gen_dict.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""Tests for generated dict functions."""
from typing import Type
from typing import Dict, Type

import pytest
from attr import Factory, define, field
@@ -8,7 +8,7 @@
from hypothesis.strategies import data, just, one_of, sampled_from

from cattrs import BaseConverter, Converter
from cattrs._compat import adapted_fields, fields
from cattrs._compat import adapted_fields, fields, is_py39_plus
from cattrs.errors import ClassValidationError, ForbiddenExtraKeysError
from cattrs.gen import make_dict_structure_fn, make_dict_unstructure_fn, override

@@ -287,3 +287,20 @@ class A:
assert structured.a == 1
assert structured.c == 1
assert not hasattr(structured, "b")


@pytest.mark.skipif(not is_py39_plus, reason="literals and annotated are 3.9+")
def test_type_names_with_quotes():
"""Types with quote characters in their reprs should work."""
from typing import Annotated, Literal, Union

converter = Converter()

assert converter.structure({1: 1}, Dict[Annotated[int, "'"], int]) == {1: 1}

converter.register_structure_hook_func(
lambda t: t is Union[Literal["a", 2, 3], Literal[4]], lambda v, _: v
)
assert converter.structure(
{2: "a"}, Dict[Union[Literal["a", 2, 3], Literal[4]], str]
) == {2: "a"}