-
-
Notifications
You must be signed in to change notification settings - Fork 113
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
cattr.structure doesn't support generic parameters. #149
Comments
Yeah I'd definitely be open to merging in something that fixes this. |
this may be our last remaining blocker to using the GenConverter - for some reason it seems this was not an issue with the old converter? At least, using the old converter our code doesn't blow up and structures properly, but switching over, things now seem to be broken. @asford it feels like you're close to a solution. Would you recommend the code above as a starting point, or do you think there's something missing there? I can probably dive in and fix this, but trying to decide how much context I really need to load into my head in order to do so. |
I can also take a stab at this if I get some spare cycles |
Tentative fix over at https://github.com/Tinche/cattrs/tree/tin/generic-structuring-fix. Feel free to try it out! |
I apparently should have looked for tickets before I went about fixing this. I made a couple adjustments to your branch to solve the deeply nested problem, now it shouldn't matter how deep of a chain someone makes it should nest properly. I also added a default NoneType handler. I can roll that out, but I found it was used in my generic code and figured it would be useful to have a default implementation. |
…1 in /packages/@jsii/python-runtime (#3315) Updates the requirements on [cattrs](https://github.com/python-attrs/cattrs) to permit the latest version. <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/python-attrs/cattrs/blob/main/HISTORY.rst">cattrs's changelog</a>.</em></p> <blockquote> <h2>1.10.0 (2022-01-04)</h2> <ul> <li>Add PEP 563 (string annotations) support for dataclasses. (<code>[#195](python-attrs/cattrs#195) <https://github.com/python-attrs/cattrs/issues/195></code>_)</li> <li>Fix handling of dictionaries with string Enum keys for bson, orjson, and tomlkit.</li> <li>Rename the <code>cattr.gen.make_dict_unstructure_fn.omit_if_default</code> parameter to <code>_cattrs_omit_if_default</code>, for consistency. The <code>omit_if_default</code> parameters to <code>GenConverter</code> and <code>override</code> are unchanged.</li> <li>Following the changes in <code>attrs</code> 21.3.0, add a <code>cattrs</code> package mirroring the existing <code>cattr</code> package. Both package names may be used as desired, and the <code>cattr</code> package isn't going away.</li> </ul> <h2>1.9.0 (2021-12-06)</h2> <ul> <li>Python 3.10 support, including support for the new union syntax (<code>A | B</code> vs <code>Union[A, B]</code>).</li> <li>The <code>GenConverter</code> can now properly structure generic classes with generic collection fields. (<code>[#149](python-attrs/cattrs#149) <https://github.com/python-attrs/cattrs/issues/149></code>_)</li> <li><code>omit=True</code> now also affects generated structuring functions. (<code>[#166](python-attrs/cattrs#166) <https://github.com/python-attrs/cattrs/issues/166></code>_)</li> <li><code>cattr.gen.{make_dict_structure_fn, make_dict_unstructure_fn}</code> now resolve type annotations automatically when PEP 563 is used. (<code>[#169](python-attrs/cattrs#169) <https://github.com/python-attrs/cattrs/issues/169></code>_)</li> <li>Protocols are now unstructured as their runtime types. (<code>[#177](python-attrs/cattrs#177) <https://github.com/python-attrs/cattrs/pull/177></code>_)</li> <li>Fix an issue generating structuring functions with renaming and <code>_cattrs_forbid_extra_keys=True</code>. (<code>[#190](python-attrs/cattrs#190) <https://github.com/python-attrs/cattrs/issues/190></code>_)</li> </ul> <h2>1.8.0 (2021-08-13)</h2> <ul> <li>Fix <code>GenConverter</code> mapping structuring for unannotated dicts on Python 3.8. (<code>[#151](python-attrs/cattrs#151) <https://github.com/python-attrs/cattrs/issues/151></code>_)</li> <li>The source code for generated un/structuring functions is stored in the <code>linecache</code> cache, which enables more informative stack traces when un/structuring errors happen using the <code>GenConverter</code>. This behavior can optionally be disabled to save memory.</li> <li>Support using the attr converter callback during structure. By default, this is a method of last resort, but it can be elevated to the default by setting <code>prefer_attrib_converters=True</code> on <code>Converter</code> or <code>GenConverter</code>. (<code>[#138](python-attrs/cattrs#138) <https://github.com/python-attrs/cattrs/issues/138></code>_)</li> <li>Fix structuring recursive classes. (<code>[#159](python-attrs/cattrs#159) <https://github.com/python-attrs/cattrs/issues/159></code>_)</li> <li>Converters now support un/structuring hook factories. This is the most powerful and complex venue for customizing un/structuring. This had previously been an internal feature.</li> <li>The <code>Common Usage Examples <https://cattrs.readthedocs.io/en/latest/usage.html#using-factory-hooks></code>_ documentation page now has a section on advanced hook factory usage.</li> <li><code>cattr.override</code> now supports the <code>omit</code> parameter, which makes <code>cattrs</code> skip the atribute entirely when unstructuring.</li> <li>The <code>cattr.preconf.bson</code> module is now tested against the <code>bson</code> module bundled with the <code>pymongo</code> package, because that package is much more popular than the standalone PyPI <code>bson</code> package.</li> </ul> <h2>1.7.1 (2021-05-28)</h2> <ul> <li><code>Literal</code> s are not supported on Python 3.9.0 (supported on 3.9.1 and later), so we skip importing them there. (<code>[#150](python-attrs/cattrs#150) <https://github.com/python-attrs/cattrs/issues/150></code>_)</li> </ul> <h2>1.7.0 (2021-05-26)</h2> <ul> <li><code>cattr.global_converter</code> (which provides <code>cattr.unstructure</code>, <code>cattr.structure</code> etc.) is now an instance of <code>cattr.GenConverter</code>.</li> <li><code>Literal</code> s are now supported and validated when structuring.</li> <li>Fix dependency metadata information for <code>attrs</code>. (<code>[#147](python-attrs/cattrs#147) <https://github.com/python-attrs/cattrs/issues/147></code>_)</li> <li>Fix <code>GenConverter</code> mapping structuring for unannotated dicts. (<code>[#148](python-attrs/cattrs#148) <https://github.com/python-attrs/cattrs/issues/148></code>_)</li> </ul> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/python-attrs/cattrs/commit/7d3a6ba5e0df942391349e332cb87f6871088015"><code>7d3a6ba</code></a> Bump to 1.10.0</li> <li><a href="https://github.com/python-attrs/cattrs/commit/22b24c28fbeb2b8ca90d568dc4939bdc98ec5902"><code>22b24c2</code></a> Tin/import cattrs (<a href="https://github-redirect.dependabot.com/python-attrs/cattrs/issues/203">#203</a>)</li> <li><a href="https://github.com/python-attrs/cattrs/commit/a0e56f43f061c43814d6f938833d1c325ed61525"><code>a0e56f4</code></a> Fix test with 32-bit time_t</li> <li><a href="https://github.com/python-attrs/cattrs/commit/bc9432e606177fe10aa3d2d11e715970c92526be"><code>bc9432e</code></a> Documentation tweaks</li> <li><a href="https://github.com/python-attrs/cattrs/commit/6260c58aa185200a08c76ecc99a941a26a93eeb8"><code>6260c58</code></a> Rename gen.make_dict_unstructure_fn.omit_if_default</li> <li><a href="https://github.com/python-attrs/cattrs/commit/bb4383c2d97aae0e8a01db64f142d07350861a17"><code>bb4383c</code></a> Remove walrus</li> <li><a href="https://github.com/python-attrs/cattrs/commit/81d7756541129a73b82f076b860d61c550296666"><code>81d7756</code></a> Clean up test</li> <li><a href="https://github.com/python-attrs/cattrs/commit/de16200c3d02d259d04960ab466f49fcf8fa47a4"><code>de16200</code></a> Fix preconf string Enum keys</li> <li><a href="https://github.com/python-attrs/cattrs/commit/077c9ea8521372f706346f1f39101db716ca3089"><code>077c9ea</code></a> CI tweak</li> <li><a href="https://github.com/python-attrs/cattrs/commit/3ad74d4456c19598e7278deef62e3af85eabc99d"><code>3ad74d4</code></a> setup.cfg B gone</li> <li>Additional commits viewable in <a href="https://github.com/python-attrs/cattrs/compare/v1.8.0...v1.10.0">compare view</a></li> </ul> </details> <br /> Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details>
Is this fixed by #177 in the 1.8 release? |
@asford Yes, it should be, could you give it a try? |
I've verified this via the test inlined below. This failed in 1.7 but now succeeds in 1.10. Thanks! from typing import Generic, Dict, TypeVar
import attr
import cattr
import pytest
T = TypeVar("T")
V = TypeVar("V")
@attr.frozen
class Col(Generic[T]):
vals: Dict[str, T]
@attr.frozen
class NestCol(Generic[V]):
v: Col[V]
@attr.frozen
class IntV:
v: Col[int]
def test_run():
sv = {str(i): str(i) for i in range(1, 5)}
iv = {str(i): i for i in range(1, 5)}
tv = dict(vals={i: i for i in [1, "2", "3", 4]})
tn = dict(v=tv)
assert cattr.structure(tv, Col[str]).vals == sv
assert cattr.structure(tv, Col[int]).vals == iv
assert cattr.structure(tn, NestCol[str]).v.vals == sv
assert cattr.structure(tn, NestCol[int]).v.vals == iv
assert cattr.structure(tn, IntV).v.vals == iv
# Missing TypeVar
with pytest.raises(KeyError):
cattr.structure(tn, NestCol).v.vals |
…2 in /packages/@jsii/python-runtime (#3470) Updates the requirements on [cattrs](https://github.com/python-attrs/cattrs) to permit the latest version. <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/python-attrs/cattrs/blob/main/HISTORY.rst">cattrs's changelog</a>.</em></p> <blockquote> <h2>22.1.0 (2022-04-03)</h2> <ul> <li>cattrs now uses the CalVer versioning convention.</li> <li>cattrs now has a detailed validation mode, which is enabled by default. Learn more <code>here <https://cattrs.readthedocs.io/en/latest/validation.html></code>_. The old behavior can be restored by creating the converter with <code>detailed_validation=False</code>.</li> <li><code>attrs</code> and dataclass structuring is now ~25% faster.</li> <li>Fix an issue structuring bare <code>typing.List</code> s on Pythons lower than 3.9. (<code>[#209](python-attrs/cattrs#209) <https://github.com/python-attrs/cattrs/issues/209></code>_)</li> <li>Fix structuring of non-parametrized containers like <code>list/dict/...</code> on Pythons lower than 3.9. (<code>[#218](python-attrs/cattrs#218) <https://github.com/python-attrs/cattrs/issues/218></code>_)</li> <li>Fix structuring bare <code>typing.Tuple</code> on Pythons lower than 3.9. (<code>[#218](python-attrs/cattrs#218) <https://github.com/python-attrs/cattrs/issues/218></code>_)</li> <li>Fix a wrong <code>AttributeError</code> of an missing <code>__parameters__</code> attribute. This could happen when inheriting certain generic classes – for example <code>typing.*</code> classes are affected. (<code>[#217](python-attrs/cattrs#217) <https://github.com/python-attrs/cattrs/issues/217></code>_)</li> <li>Fix structuring of <code>enum.Enum</code> instances in <code>typing.Literal</code> types. (<code>[#231](python-attrs/cattrs#231) <https://github.com/python-attrs/cattrs/pull/231></code>_)</li> <li>Fix unstructuring all tuples - unannotated, variable-length, homogenous and heterogenous - to <code>list</code>. (<code>[#226](python-attrs/cattrs#226) <https://github.com/python-attrs/cattrs/issues/226></code>_)</li> <li>For <code>forbid_extra_keys</code> raise custom <code>ForbiddenExtraKeyError</code> instead of generic <code>Exception</code>. (<code>[#225](python-attrs/cattrs#225) <https://github.com/python-attrs/cattrs/pull/225></code>_)</li> <li>All preconf converters now support <code>loads</code> and <code>dumps</code> directly. See an example <code>here <https://cattrs.readthedocs.io/en/latest/preconf.html></code>_.</li> <li>Fix mappings with byte keys for the orjson, bson and tomlkit converters. (<code>[#241](python-attrs/cattrs#241) <https://github.com/python-attrs/cattrs/issues/241></code>_)</li> </ul> <h2>1.10.0 (2022-01-04)</h2> <ul> <li>Add PEP 563 (string annotations) support for dataclasses. (<code>[#195](python-attrs/cattrs#195) <https://github.com/python-attrs/cattrs/issues/195></code>_)</li> <li>Fix handling of dictionaries with string Enum keys for bson, orjson, and tomlkit.</li> <li>Rename the <code>cattr.gen.make_dict_unstructure_fn.omit_if_default</code> parameter to <code>_cattrs_omit_if_default</code>, for consistency. The <code>omit_if_default</code> parameters to <code>GenConverter</code> and <code>override</code> are unchanged.</li> <li>Following the changes in <code>attrs</code> 21.3.0, add a <code>cattrs</code> package mirroring the existing <code>cattr</code> package. Both package names may be used as desired, and the <code>cattr</code> package isn't going away.</li> </ul> <h2>1.9.0 (2021-12-06)</h2> <ul> <li>Python 3.10 support, including support for the new union syntax (<code>A | B</code> vs <code>Union[A, B]</code>).</li> <li>The <code>GenConverter</code> can now properly structure generic classes with generic collection fields. (<code>[#149](python-attrs/cattrs#149) <https://github.com/python-attrs/cattrs/issues/149></code>_)</li> <li><code>omit=True</code> now also affects generated structuring functions. (<code>[#166](python-attrs/cattrs#166) <https://github.com/python-attrs/cattrs/issues/166></code>_)</li> <li><code>cattr.gen.{make_dict_structure_fn, make_dict_unstructure_fn}</code> now resolve type annotations automatically when PEP 563 is used. (<code>[#169](python-attrs/cattrs#169) <https://github.com/python-attrs/cattrs/issues/169></code>_)</li> <li>Protocols are now unstructured as their runtime types. (<code>[#177](python-attrs/cattrs#177) <https://github.com/python-attrs/cattrs/pull/177></code>_)</li> <li>Fix an issue generating structuring functions with renaming and <code>_cattrs_forbid_extra_keys=True</code>. (<code>[#190](python-attrs/cattrs#190) <https://github.com/python-attrs/cattrs/issues/190></code>_)</li> </ul> <h2>1.8.0 (2021-08-13)</h2> <ul> <li>Fix <code>GenConverter</code> mapping structuring for unannotated dicts on Python 3.8.</li> </ul> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li>See full diff in <a href="https://github.com/python-attrs/cattrs/commits">compare view</a></li> </ul> </details> <br /> Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details>
Partially a note to myself, if you're open to a PR fixing this.
cattr
has solid support for generics in unstructure/structure operations, however it doesn't fully support nested generic types.Consider instances where a generic attrs class contains a generic collection as a member...
...this fails, though one might expect cattr to propagate the
T
typevar into theDict[str, T]
generic member for an inferredDict[str, int]
field type.This can probably be fixed by mildly extending the existing gen converter logic.
All the
TypeVar
s in the current context are already resolved intomapping
at:https://github.com/Tinche/cattrs/blob/71a7ed2b4c72558af77487ae991f19cc5401c378/src/cattr/gen.py#L117-L126
which is then used to map
TypeVar
s to their concrete type in the generated converter at:https://github.com/Tinche/cattrs/blob/71a7ed2b4c72558af77487ae991f19cc5401c378/src/cattr/gen.py#L155-L161
Here, generic types could be detected via
typing.get_args
or the equivalent_compat
function.If the attribute type contains any
TypeVar
args, these could be replaced viamapping
lookups and an updated type created withtype.copy_with
:This will probably be fragile to updates in the
typing
module, so should probably be moved into _compat.The text was updated successfully, but these errors were encountered: