PyStrong 0.0.7

Type enforcement for python objects.

Pystrong. Type enforcement for python objects

Abstract

This package is inspired by the Python dataclasses. While dataclasses are amazing, I never really liked the way they go about type checking/enforcement. This package offers some clean and simple tools to help with type enforcement in Python.

Usage

BaseClasses

Use the TypeEnforcer class as a base class and the types you set for the attributes of your derived classes will be enforced throughout the life of the object. When creating the class Person, the first thing the constructor must do is call base classes constructor passing the all attributes with their intended type as key value pairs. Thereafter, the object should behave as normal.

from pystrong import TypeEnforcer

class Person(TypeEnforcer):
    def __init__(self, name, age):
        super().__init__(name=str, age=int)
        self.name = name
        self.age = age

p = Person('Jake', 32)

Instances of the person class now have a clean repr, and are type enforced.

p
Person(name:str='Jake', age:int=32)

p.name = 55
EnforcedTypeError: Can not assign type: <class 'int'> to attribute 'name'. Must be of type: <class 'str'>

EnforcedTypeError is thrown because the value of the name attribute on a Person object must always be a string.

One caveat with the TypeEnforcer is that you can not add attributes to the class after initializing it due to no type value being set. If you want a object that can have attributes added you can use the InferredTypeEnforcer. This base class will just take the initial value of any attribute infer the type, and treat that as the type to enforce.

from pystrong import InferredTypeEnforcer

class Person(InferredTypeEnforcer):
   def __init__(self, name, age):
        self.name = name
        self.age = age

p = Person("Jake", 32)
p.height = 34.65

p
Person(name:str='Jake', age:int=32, height:float=34.65)

p.name = 55
EnforcedTypeError: Can not assign type: <class 'int'> to attribute 'name'. Must be of type: <class 'str'>

Decorators

There are also some handy decorators to ensure that a method arguments are the right type, or that the method returns the proper type. Using the check_return_types decorator will throw an error if the method returns an invalid type.

from pystrong import check_return_types

@check_return_types(str, int)
def test_success():
    return "Hello World", 500

@check_return_types(str, int)
def test_fail():
    return 500, {"test": "error"}

test_success()
("Hello World", 500)

test_fail()
EnforcedReturnTypeError: Function 'test_fail' returned '500' of type '<class 'int'>'. Expected return type is '<class 'str'>'.

The check_arg_type decorator can be used to enforce that arguments to the function are of the proper type.

from pystrong import check_arg_type

@check_arg_type(int, str)
def add_10(num, string):
    print(string)
    return num+10

@check_arg_type(int, str)
def error(num, string):
    print(string)
    return "error"

add_10(5, "Hello World")
Hello World
15

add_10("throw", "error")
EnforcedArgTypeError: Argument 'throw' must be of type <class 'int'>

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please update tests accordingly.

License

MIT