Python classes with types validation at runtime.

Last update: Feb 06, 2022

Overview

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") TypeError: Parameter 'id' must be an instance of 
,

is unsupported.">
>>> 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.

Flake8 plugin that checks import order against various Python Style Guides

flake8-import-order A flake8 and Pylama plugin that checks the ordering of your imports. It does not check anything else about the imports. Merely tha

270 Nov 24, 2022

Flake8 extension for checking quotes in python

Flake8 Extension to lint for quotes. Major update in 2.0.0 We automatically encourage avoiding escaping quotes as per PEP 8. To disable this, use --no

157 Dec 13, 2022

Check for python builtins being used as variables or parameters

Flake8 Builtins plugin Check for python builtins being used as variables or parameters. Imagine some code like this: def max_values(list, list2):

98 Jan 8, 2023

flake8 plugin to run black for checking Python coding style

flake8-black Introduction This is an MIT licensed flake8 plugin for validating Python code style with the command line code formatting tool black. It

146 Dec 15, 2022

Custom Python linting through AST expressions

bellybutton bellybutton is a customizable, easy-to-configure linting engine for Python. What is this good for? Tools like pylint and flake8 provide, o

249 Dec 31, 2022

Naming Convention checker for Python

PEP 8 Naming Conventions Check your code against PEP 8 naming conventions. This module provides a plugin for flake8, the Python code checker. (It repl

411 Dec 23, 2022

Code audit tool for python.

967 Jan 7, 2023

Flake8 extension for enforcing trailing commas in python

Flake8 Extension to enforce better comma placement. Usage If you are using flake8 it's as easy as: pip install flake8-commas Now you can avoid those a

127 Sep 3, 2022

Tool for pinpointing circular imports in Python. Find cyclic imports in any project

Pycycle: Find and fix circular imports in python projects Pycycle is an experimental project that aims to help python developers fix their circular de

311 Dec 15, 2022

Releases(0.0.1)

0.0.1(Feb 2, 2022)

Initial release.

Commits history: https://github.com/nerdguyahmad/typedclasses/commits/0.0.1
Source code(tar.gz)
Source code(zip)

Python classes with types validation at runtime.

Related tags

Overview

typedclasses

Installation

How it works

Contribute

You might also like...

Flake8 plugin that checks import order against various Python Style Guides

Flake8 extension for checking quotes in python

Check for python builtins being used as variables or parameters

flake8 plugin to run black for checking Python coding style

Custom Python linting through AST expressions

Naming Convention checker for Python

Code audit tool for python.

Flake8 extension for enforcing trailing commas in python

Tool for pinpointing circular imports in Python. Find cyclic imports in any project

Releases(0.0.1)

0.0.1(Feb 2, 2022)

Owner

Izhar Ahmad

flake8 plugin to run black for checking Python coding style

Flake8 extension to provide force-check option

Performant type-checking for python.

A python documentation linter which checks that the docstring description matches the definition.

Tool to check the completeness of MANIFEST.in for Python packages

OpenStack Hacking Style Checks. Mirror of code maintained at opendev.org.

A plugin for Flake8 finding likely bugs and design problems in your program. Contains warnings that don't belong in pyflakes and pycodestyle.

Type stubs for the lxml package

Collection of awesome Python types, stubs, plugins, and tools to work with them.

Tool for automatically reordering python imports. Similar to isort but uses static analysis more.

Naming Convention checker for Python

Simple Python style checker in one Python file

Custom Python linting through AST expressions

mypy plugin to type check Kubernetes resources

Mypy stubs, i.e., type information, for numpy, pandas and matplotlib

MonkeyType as a pytest plugin.

An open-source, mini imitation of GitHub Copilot for Emacs.

Enforce the same configuration across multiple projects

Mypy plugin and stubs for SQLAlchemy

mypy plugin for loguru