Typed Dataclass is a Python library providing a decorator for dataclasses that enables runtime type checking.
Use the package manager pip to install typed-dataclass.
pip install typed-dataclass
This library should be used in conjunction with the @dataclas decorator and should be placed
below @dataclass. On object initialization it checks types by using
typeguard package. Internally this works by modifying
the __post__init__ method of the dataclass.
from dataclasses import dataclass
from typed_dataclass import typed_dataclass
@dataclass
@typed_dataclass
class MyClass:
my_field: int
MyClass(12) # will succeed
MyClass ("a") # will failYou can also implement logic that is happening before Type checks defining __before_type_check__ function:
from dataclasses import dataclass
from typed_dataclass import typed_dataclass
@dataclass
@typed_dataclass
class MyClass:
my_int: int
def __before_type_check__(self):
self.my_int = int(self.my_int)python -m unittest discover tests
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.