typedclasses
Python classes with types validation at runtime. (Experimental & Under Development)
Installation
You can install this library using Python's favorite, pip package manager.
pip install -U typedclasses
How it works
Using typedclasses, you can create classes in dataclasses-like manner i.e using type annotations and library will enforce types for that class at runtime. Here's an example:
import typing
from typedclasses import TypedClass
class User(TypedClass):
id: int
name: str
email: typing.Optional[str] = None
Parameters will be validated when initialising above class. Since email has a default value set, It is optional to pass it as a parameter while instansiating:
>>> User(id=1, name="foobar") # runs fine >>> User(id="1", name="foobar") TypeError: Parameter 'id' must be an instance of <class 'int'>, <class 'str'> is unsupported.
This library also provides validation for various generic types from typing module:
class Foo(TypedClass):
x: typing.Union[str, int]
Foo(x="a") # ok
Foo(x=1) # ok
Foo(x=True) # invalid
List of all types supported from typing module can be found in the documentation.
Contribute
You can contribute to the library in two ways:
- Directly contributing to code using pull requests.
- Suggest features or report bugs via issues.
We welcome all contributions!
When using issues, Please be descriptive about your issue and for pull requests, Try to be consistent with current design.
270 Nov 24, 2022
157 Dec 13, 2022
98 Jan 8, 2023
146 Dec 15, 2022
249 Dec 31, 2022
967 Jan 7, 2023
311 Dec 15, 2022
12 Jul 14, 2020
139 Dec 30, 2022
36 Oct 29, 2022
2 Jan 04, 2022
146 Dec 28, 2022
13 Nov 02, 2022
6 Mar 26, 2021
45 Dec 13, 2022
1.1k Jan 02, 2023
183 Dec 18, 2022
42 Sep 25, 2022
315 Dec 25, 2022
2 Jul 15, 2022
589 Dec 26, 2022