-
-
Notifications
You must be signed in to change notification settings - Fork 108
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
cattrs does not unstructure os.PathLike to str #417
Comments
We don't support When generating the unstructuring code, cattrs looks at the type of the field in the class rather than the actual runtime value of the field. If cattrs doesn't know how to unstructure a field, it just passes it through, which is what you're seeing. (For structuring it's different, there it would be an exception.) To solve the issue, you can register a super simple hook yourself: c.register_unstructure_hook(PathLike, str) |
I see. This was not obvious from the documentation. Perhaps there is value in a "strict mode" that would ensure that either everything is unstructured to primitive types or an exception is thrown? Such a mode could then be auto-enabled for the preconfigured converters. |
I can consider it, but what's the use case? Either cattrs raises something or your json lib raises something, feels like it ends up being the same? |
Description
When unstructuring an attrs class where one of the fields is annotated as
os.PathLike
(and contains a Path), that field remains a Path (in my case,PosixPath
) instead of being unstructured asstr
.Curiously, annotating the field as
Union[str, os.PathLike]
orpathlib.Path
(without changing the actual data type) resolves the issue.What I Did
I'm not saying that this must be a bug (rather than merely my mis-usage of
cattrs
), but I was not able to find anything in the docs that would suggest that I was doing something incorrectly.The text was updated successfully, but these errors were encountered: