gahjelle / datadict Goto Github PK

I needed a dict-like dataclass and was going to implement it myself, but I did some Googling and found that your implementation does the trick. Thanks!

One minor issue I found is that your "dataclass-like" decorator isn't understood by type checkers like mypy and pyright as of now. This is a known limitation of user-defined dataclass-like functions, described and fixed in PEP 681. The error given by pyright is "Untyped class decorator obscures type of class; ignoring decorator".

If you're up for it, I can submit a Pull Request implementing this change. I recommend the "simple fix" below, which adds a dependency to typing_extensions (which itself requires Python 3.7 at minimum). But there's also a fix that doesn't add any dependencies, though it will bump your minimum supported Python to 3.8.

Simple fix and an added dependency (dependency needs Python 3.7+)

The fix will be available in the standard library in 3.11, but is available today through typing_extensions. Your package could be updated to support PEP 681 by adding the typing_extensions dependency and declaring the import:

from typing_extensions import dataclass_transform

And changing this:

to this:

@dataclass_transform()
 def dataclass(cls=None, **kwargs): 

Since 3.11 will have dataclass_transform built in, typing_extensions conditionally chooses its own implementation for pre 3.11, and imports the built-in for 3.11 onward.

More involved fix and no added dependencies (using Python 3.8+ protocols)

See the "Enforcing dataclasses" section of this StackOverflow answer.