Helpers for Generic Python Classes
Project description
EASY Class is a toolkit for creating generic classes in an elegant way.
Usage
from easy_class import EasyClass, StringVariable, IntegerVariable
class MyClass(EasyClass):
attr1 = IntegerVariable()
attr2 = StringVariable()The above code declares a class with two member variables attr1 and attr2, where attr1 can only be an integer value and attr2 can only be a string. Hence, if you try to do the following
obj = MyClass()
obj.attr1 = "Test"it will raise the exception TypeError: attr1 expects int type, but received str.
Class Variable Reference
All Variable types (i.e. IntegerVariable, StringVariable) are inherited from the class Variable which represents a class attribute type. Below contains all the API references of Variable including the variable options and field types this package offers.
Variable options
The following arguments are available to all variable types. All are optional.
null
Variable.null
If False the attribute cannot be assigned a NULL variable. Default is True. You cannot also instantiate a class which has any Non-nullable attributes without specifying the correct arguments. Below is what I meant to say.
class MyClass(EasyClass):
attr1 = IntegerVariable(null=False)
attr2 = StringVariable(null=False)
obj = MyClass()The above will raise the exception ValueError: Following attributes cannot be null: [attr2, attr1]
choices
Variable.choices
A list to use as choices for the attribute. Will raise exception if value being is stored is not included in this list of choices.
default
Variable.default
The default value for the attribute. Right now, callables are not supported.
Variable Types
IntegerVariable
An Integer Variable
StringVariable
A string variable, for small- to large-sized strings. StringVariable has the following extra arguments
StringVariable.max_length
The maximum length (in characters) of the attribute. Defaults 255.
StringVariable.min_length
The minimum length (in characters) of the attribute. Defaults 0.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for easy_class-1.0.0.dev1-py2-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3031b43f47e55461158775a3cfc9d4dde892cd0d524c21737abef547552290b0 |
|
| MD5 | 73f207337393aa3521e5fbb2ff4110f1 |
|
| BLAKE2b-256 | d61508cc3befed3c1f278ac106986d1320b1e37b2b94b47cba3b67cb55fcbed4 |
