constantia 0.0.5

Enforce constants at import time

constantia

Enforce constants in your code at import or at run time.

Usage

Use the consts decorator and pass as parameters a list of variables you want to treat as constants.

The variables in the constant list cannot be re-assigned nor they can be assigned a mutable object. They can only be assigned:

• strings
• integers
• floats
• tuples

This is done to avoid indirect modifications.

Choose if you want to do the checks at runtime or when importing the function by setting the check_at argument.

Examples

Function

Checking the constants at import time

from constantia import consts

@consts(['x', 'y', 'z'], check_at='import')
def func():
    x = [1, 2, 3] # this will crash at import time as the constant does not have an immutable value
    y = 20
    y = 30  # this will raise an exception at import time as the constant is reassigned

Checking the constants at run time

from constantia import consts

@consts(['x', 'y', 'z'], check_at='runtime')
def func():
    x = [1, 2, 3] # this will rais an exception when trying to run the function
    y = 20
    y = 30  # this will rais an exception when trying to run the function

Class constants

Ensuring every uppercase attribute is a constant

from constantia import consts

@consts('uppercase', check_at='import')
class Example:
    X = 9999
    Y = 'other constant'
    X = 888  # this will raise an exception

Ensuring a constant is not re-assignable

from constantia import consts

@consts(['X'], check_at='import')
class Example:
    X = 9999
    X = 888  # this will raise an exception

    @classmethod
    def change_x1(cls):
        cls.X = 8888  # this will raise an exception

    @staticmethod
    def change_x2():
        Example.X = 8888  # this will raise an exception

Sensible defaults: constants are uppercase and check the constants at import time

from constantia import consts

@consts
class Example:
    X = 9999
    Y = 'other constant'
    X = 888  # this will raise an exception

Dependencies

This package has no dependencies.

License

MIT license, but if you need any other contact me.