asyncorm.models package

Submodules

asyncorm.models.field module

class asyncorm.models.field.Field(**kwargs)

Bases: object

Base Field of AsyncOrm.

Any developer defined Field should subclass Field.

creation_query()

Create the field’s database creation query.

Returns:query constructed Return type:str

creation_string = None

current_state()

internal_type = None

classmethod recompose(value)

required_kwargs = []

sanitize_data(value)

Sanitize the query before send to database.

serialize_data(value)

to directly serialize the data field passed

set_field_name(db_column)

table_name = None

validate(value)

Validate the value.

Parameters:value (self.internal_type) – value in the field Raises:AsyncOrmFieldError –

• When a null value sent to a non nullable field.
• When the value provided is not in the field choices.
• When the value provided is not in the self.internal_type

validate_kwargs(kwargs)

Validate the kwargs provided.

Parameters:kwargs (dict) – Field creation kwargs Raises:AsyncOrmFieldError – If a required field is not provided or when a value provided doesn’t comply to Field requirements.

asyncorm.models.fields module

class asyncorm.models.fields.ArrayField(db_column='', db_index=False, default=None, null=True, unique=False, value_type='text')

Bases: asyncorm.models.field.Field

args = ('db_column', 'db_index', 'default', 'null', 'unique', 'value_type')

creation_string = '{value_type} ARRAY'

static homogeneous_type(value)

internal_type

alias of builtins.list

validate(value)

Validate the value.

Parameters:value (self.internal_type) – value in the field Raises:AsyncOrmFieldError –

• When a null value sent to a non nullable field.
• When the value provided is not in the field choices.
• When the value provided is not in the self.internal_type

value_types = ('text', 'varchar', 'integer')

class asyncorm.models.fields.AutoField(db_column='id')

Bases: asyncorm.models.fields.IntegerField

args = ('choices', 'db_column', 'db_index', 'default', 'null', 'unique')

creation_string = 'serial PRIMARY KEY'

class asyncorm.models.fields.BigIntegerField(choices=None, db_column='', db_index=False, default=None, null=False, unique=False)

Bases: asyncorm.models.fields.IntegerField

creation_string = 'bigint'

class asyncorm.models.fields.BooleanField(db_column='', db_index=False, default=None, null=False, unique=False)

Bases: asyncorm.models.field.Field

args = ('choices', 'db_column', 'db_index', 'default', 'null', 'unique')

creation_string = 'boolean'

internal_type

alias of builtins.bool

sanitize_data(value)

method used to convert to SQL data

class asyncorm.models.fields.CharField(choices=None, db_column='', db_index=False, default=None, max_length=0, null=False, unique=False)

Bases: asyncorm.models.field.Field

args = ('choices', 'db_column', 'db_index', 'default', 'max_length', 'null', 'unique')

creation_string = 'varchar({max_length})'

internal_type

alias of builtins.str

classmethod recompose(value)

required_kwargs = ['max_length']

sanitize_data(value)

Sanitize the query before send to database.

class asyncorm.models.fields.DateField(auto_now=False, choices=None, db_column='', db_index=False, default=None, null=False, strftime=None, unique=False)

Bases: asyncorm.models.fields.DateTimeField

args = ('auto_now', 'choices', 'db_column', 'db_index', 'default', 'null', 'strftime', 'unique')

creation_string = 'date'

internal_type

alias of datetime.date

strftime = '%Y-%m-%d'

class asyncorm.models.fields.DateTimeField(auto_now=False, choices=None, db_column='', db_index=False, default=None, null=False, strftime=None, unique=False)

Bases: asyncorm.models.field.Field

args = ('auto_now', 'choices', 'db_column', 'db_index', 'default', 'null', 'strftime', 'unique')

creation_string = 'timestamp'

internal_type

alias of datetime.datetime

serialize_data(value)

to directly serialize the data field passed

strftime = '%Y-%m-%d %H:%s'

class asyncorm.models.fields.DecimalField(choices=None, db_column='', db_index=False, decimal_places=2, default=None, max_digits=10, null=False, unique=False)

Bases: asyncorm.models.fields.NumberField

args = ('choices', 'db_column', 'db_index', 'decimal_places', 'default', 'null', 'unique', 'max_digits')

creation_string = 'decimal({max_digits},{decimal_places})'

internal_type = (<class 'decimal.Decimal'>, <class 'float'>, <class 'int'>)

class asyncorm.models.fields.EmailField(choices=None, db_column='', db_index=False, default=None, max_length=0, null=False, unique=False)

Bases: asyncorm.models.fields.CharField

validate(value)

Validate the value.

Parameters:value (self.internal_type) – value in the field Raises:AsyncOrmFieldError –

• When a null value sent to a non nullable field.
• When the value provided is not in the field choices.
• When the value provided is not in the self.internal_type

class asyncorm.models.fields.FloatField(choices=None, db_column='', db_index=False, default=None, null=False, unique=False)

Bases: asyncorm.models.fields.NumberField

args = ('choices', 'db_column', 'db_index', 'default', 'null', 'unique')

creation_string = 'double precision'

internal_type

alias of builtins.float

class asyncorm.models.fields.ForeignKey(db_column='', db_index=False, default=None, foreign_key='', null=False, unique=False)

Bases: asyncorm.models.field.Field

args = ('db_column', 'db_index', 'default', 'foreign_key', 'null', 'unique')

creation_string = 'integer references {foreign_key}'

internal_type

alias of builtins.int

required_kwargs = ['foreign_key']

class asyncorm.models.fields.GenericIPAddressField(db_column='', db_index=False, null=False, protocol='both', unique=False, unpack_protocol='same')

Bases: asyncorm.models.field.Field

args = ('db_column', 'db_index', 'null', 'protocol', 'unique', 'unpack_protocol')

creation_string = 'INET'

internal_type

alias of netaddr.ip.IPNetwork

recompose(value)

sanitize_data(value)

Sanitize the query before send to database.

serialize_data(value)

to directly serialize the data field passed

validate(value)

Validate the value.

Parameters:value (self.internal_type) – value in the field Raises:AsyncOrmFieldError –

• When a null value sent to a non nullable field.
• When the value provided is not in the field choices.
• When the value provided is not in the self.internal_type

class asyncorm.models.fields.IntegerField(choices=None, db_column='', db_index=False, default=None, null=False, unique=False)

Bases: asyncorm.models.fields.NumberField

args = ('choices', 'db_column', 'db_index', 'default', 'null', 'unique')

creation_string = 'integer'

internal_type

alias of builtins.int

class asyncorm.models.fields.JsonField(choices=None, db_column='', db_index=False, default=None, max_length=0, null=False, unique=False)

Bases: asyncorm.models.field.Field

args = ('choices', 'db_column', 'db_index', 'default', 'max_length', 'null', 'unique')

creation_string = 'JSON'

internal_type = (<class 'dict'>, <class 'list'>, <class 'str'>)

classmethod recompose(value)

required_kwargs = ['max_length']

sanitize_data(value)

Sanitize the query before send to database.

class asyncorm.models.fields.MACAdressField(db_column='', db_index=False, default=None, dialect='unix', null=False, unique=True)

Bases: asyncorm.models.field.Field

args = ('db_column', 'db_index', 'default', 'dialect', 'null', 'unique')

creation_string = 'MACADDR'

internal_type

alias of netaddr.eui.EUI

mac_dialects = {'bare': <class 'netaddr.strategy.eui48.mac_bare'>, 'cisco': <class 'netaddr.strategy.eui48.mac_cisco'>, 'eui48': <class 'netaddr.strategy.eui48.mac_eui48'>, 'pgsql': <class 'netaddr.strategy.eui48.mac_pgsql'>, 'unix': <class 'netaddr.strategy.eui48.mac_unix'>, 'unix_expanded': <class 'netaddr.strategy.eui48.mac_unix_expanded'>}

recompose(value)

sanitize_data(value)

Sanitize the query before send to database.

validate(value)

Validate the value.

Parameters:value (self.internal_type) – value in the field Raises:AsyncOrmFieldError –

• When a null value sent to a non nullable field.
• When the value provided is not in the field choices.
• When the value provided is not in the self.internal_type

class asyncorm.models.fields.ManyToManyField(db_column='', db_index=False, default=None, foreign_key=None, unique=False)

Bases: asyncorm.models.field.Field

args = ('db_column', 'db_index', 'default', 'foreign_key', 'unique')

creation_query()

Create the field’s database creation query.

Returns:query constructed Return type:str

creation_string = '\n {own_model} INTEGER REFERENCES {own_model} NOT NULL,\n {foreign_key} INTEGER REFERENCES {foreign_key} NOT NULL\n '

internal_type = (<class 'list'>, <class 'int'>)

required_kwargs = ['foreign_key']

validate(value)

Validate the value.

Parameters:value (self.internal_type) – value in the field Raises:AsyncOrmFieldError –

• When a null value sent to a non nullable field.
• When the value provided is not in the field choices.
• When the value provided is not in the self.internal_type

class asyncorm.models.fields.NumberField(**kwargs)

Bases: asyncorm.models.field.Field

class asyncorm.models.fields.TextField(choices=None, db_column='', db_index=False, default=None, null=False, unique=False)

Bases: asyncorm.models.field.Field

args = ('choices', 'db_column', 'db_index', 'default', 'null', 'unique')

creation_string = 'text'

internal_type

alias of builtins.str

class asyncorm.models.fields.TimeField(auto_now=False, choices=None, db_column='', db_index=False, default=None, null=False, strftime=None, unique=False)

Bases: asyncorm.models.fields.DateTimeField

creation_string = 'time'

internal_type

alias of datetime.time

strftime = '%H:%s'

class asyncorm.models.fields.Uuid4Field(db_column='', db_index=False, null=False, unique=True, uuid_type='v4')

Bases: asyncorm.models.field.Field

args = ('db_column', 'db_index', 'null', 'unique', 'uuid_type')

creation_string

internal_type

alias of uuid.UUID

sanitize_data(value)

Sanitize the query before send to database.

asyncorm.models.models module

class asyncorm.models.models.Model(**kwargs)

Bases: asyncorm.models.models.BaseModel

DoesNotExist

alias of asyncorm.exceptions.AsyncOrmModelDoesNotExist

attr_names = {}

construct(data, deleted=False, subitems=None)

db_pk = 'id'

delete()

fields = {'id': <asyncorm.models.fields.AutoField object>}

id = <asyncorm.models.fields.AutoField object>

meta_items = ('ordering', 'unique_together', 'table_name')

objects = <asyncorm.models.models.ModelManager object>

ordering = None

orm_pk = 'id'

save(**kwargs)

table_name = ''

unique_together = []

class asyncorm.models.models.ModelSerializer

Bases: asyncorm.serializers.serializer.Serializers

classmethod serialize(instanced_model)

validate_fields()

class asyncorm.models.models.SerializerMethod(method_name='')

Bases: asyncorm.serializers.serializer.Serializers

Module contents

class asyncorm.models.ArrayField(db_column='', db_index=False, default=None, null=True, unique=False, value_type='text')

Bases: asyncorm.models.field.Field

args = ('db_column', 'db_index', 'default', 'null', 'unique', 'value_type')

creation_string = '{value_type} ARRAY'

static homogeneous_type(value)

internal_type

alias of builtins.list

validate(value)

Validate the value.

Parameters:value (self.internal_type) – value in the field Raises:AsyncOrmFieldError –

• When a null value sent to a non nullable field.
• When the value provided is not in the field choices.
• When the value provided is not in the self.internal_type

value_types = ('text', 'varchar', 'integer')

class asyncorm.models.AutoField(db_column='id')

Bases: asyncorm.models.fields.IntegerField

args = ('choices', 'db_column', 'db_index', 'default', 'null', 'unique')

creation_string = 'serial PRIMARY KEY'

class asyncorm.models.BigIntegerField(choices=None, db_column='', db_index=False, default=None, null=False, unique=False)

Bases: asyncorm.models.fields.IntegerField

creation_string = 'bigint'

class asyncorm.models.BooleanField(db_column='', db_index=False, default=None, null=False, unique=False)

Bases: asyncorm.models.field.Field

args = ('choices', 'db_column', 'db_index', 'default', 'null', 'unique')

creation_string = 'boolean'

internal_type

alias of builtins.bool

sanitize_data(value)

method used to convert to SQL data

class asyncorm.models.CharField(choices=None, db_column='', db_index=False, default=None, max_length=0, null=False, unique=False)

Bases: asyncorm.models.field.Field

args = ('choices', 'db_column', 'db_index', 'default', 'max_length', 'null', 'unique')

creation_string = 'varchar({max_length})'

internal_type

alias of builtins.str

classmethod recompose(value)

required_kwargs = ['max_length']

sanitize_data(value)

Sanitize the query before send to database.

class asyncorm.models.DateField(auto_now=False, choices=None, db_column='', db_index=False, default=None, null=False, strftime=None, unique=False)

Bases: asyncorm.models.fields.DateTimeField

args = ('auto_now', 'choices', 'db_column', 'db_index', 'default', 'null', 'strftime', 'unique')

creation_string = 'date'

internal_type

alias of datetime.date

strftime = '%Y-%m-%d'

class asyncorm.models.DateTimeField(auto_now=False, choices=None, db_column='', db_index=False, default=None, null=False, strftime=None, unique=False)

Bases: asyncorm.models.field.Field

args = ('auto_now', 'choices', 'db_column', 'db_index', 'default', 'null', 'strftime', 'unique')

creation_string = 'timestamp'

internal_type

alias of datetime.datetime

serialize_data(value)

to directly serialize the data field passed

strftime = '%Y-%m-%d %H:%s'

class asyncorm.models.DecimalField(choices=None, db_column='', db_index=False, decimal_places=2, default=None, max_digits=10, null=False, unique=False)

Bases: asyncorm.models.fields.NumberField

args = ('choices', 'db_column', 'db_index', 'decimal_places', 'default', 'null', 'unique', 'max_digits')

creation_string = 'decimal({max_digits},{decimal_places})'

internal_type = (<class 'decimal.Decimal'>, <class 'float'>, <class 'int'>)

class asyncorm.models.EmailField(choices=None, db_column='', db_index=False, default=None, max_length=0, null=False, unique=False)

Bases: asyncorm.models.fields.CharField

validate(value)

Validate the value.

Parameters:value (self.internal_type) – value in the field Raises:AsyncOrmFieldError –

• When a null value sent to a non nullable field.
• When the value provided is not in the field choices.
• When the value provided is not in the self.internal_type

class asyncorm.models.Field(**kwargs)

Bases: object

Base Field of AsyncOrm.

Any developer defined Field should subclass Field.

creation_query()

Create the field’s database creation query.

Returns:query constructed Return type:str

creation_string = None

current_state()

internal_type = None

classmethod recompose(value)

required_kwargs = []

sanitize_data(value)

Sanitize the query before send to database.

serialize_data(value)

to directly serialize the data field passed

set_field_name(db_column)

table_name = None

validate(value)

Validate the value.

Parameters:value (self.internal_type) – value in the field Raises:AsyncOrmFieldError –

• When a null value sent to a non nullable field.
• When the value provided is not in the field choices.
• When the value provided is not in the self.internal_type

validate_kwargs(kwargs)

Validate the kwargs provided.

Parameters:kwargs (dict) – Field creation kwargs Raises:AsyncOrmFieldError – If a required field is not provided or when a value provided doesn’t comply to Field requirements.

class asyncorm.models.ForeignKey(db_column='', db_index=False, default=None, foreign_key='', null=False, unique=False)

Bases: asyncorm.models.field.Field

args = ('db_column', 'db_index', 'default', 'foreign_key', 'null', 'unique')

creation_string = 'integer references {foreign_key}'

internal_type

alias of builtins.int

required_kwargs = ['foreign_key']

class asyncorm.models.GenericIPAddressField(db_column='', db_index=False, null=False, protocol='both', unique=False, unpack_protocol='same')

Bases: asyncorm.models.field.Field

args = ('db_column', 'db_index', 'null', 'protocol', 'unique', 'unpack_protocol')

creation_string = 'INET'

internal_type

alias of netaddr.ip.IPNetwork

recompose(value)

sanitize_data(value)

Sanitize the query before send to database.

serialize_data(value)

to directly serialize the data field passed

validate(value)

Validate the value.

Parameters:value (self.internal_type) – value in the field Raises:AsyncOrmFieldError –

• When a null value sent to a non nullable field.
• When the value provided is not in the field choices.
• When the value provided is not in the self.internal_type

class asyncorm.models.IntegerField(choices=None, db_column='', db_index=False, default=None, null=False, unique=False)

Bases: asyncorm.models.fields.NumberField

args = ('choices', 'db_column', 'db_index', 'default', 'null', 'unique')

creation_string = 'integer'

internal_type

alias of builtins.int

class asyncorm.models.JsonField(choices=None, db_column='', db_index=False, default=None, max_length=0, null=False, unique=False)

Bases: asyncorm.models.field.Field

args = ('choices', 'db_column', 'db_index', 'default', 'max_length', 'null', 'unique')

creation_string = 'JSON'

internal_type = (<class 'dict'>, <class 'list'>, <class 'str'>)

classmethod recompose(value)

required_kwargs = ['max_length']

sanitize_data(value)

Sanitize the query before send to database.

class asyncorm.models.MACAdressField(db_column='', db_index=False, default=None, dialect='unix', null=False, unique=True)

Bases: asyncorm.models.field.Field

args = ('db_column', 'db_index', 'default', 'dialect', 'null', 'unique')

creation_string = 'MACADDR'

internal_type

alias of netaddr.eui.EUI

mac_dialects = {'bare': <class 'netaddr.strategy.eui48.mac_bare'>, 'cisco': <class 'netaddr.strategy.eui48.mac_cisco'>, 'eui48': <class 'netaddr.strategy.eui48.mac_eui48'>, 'pgsql': <class 'netaddr.strategy.eui48.mac_pgsql'>, 'unix': <class 'netaddr.strategy.eui48.mac_unix'>, 'unix_expanded': <class 'netaddr.strategy.eui48.mac_unix_expanded'>}

recompose(value)

sanitize_data(value)

Sanitize the query before send to database.

validate(value)

Validate the value.

Parameters:value (self.internal_type) – value in the field Raises:AsyncOrmFieldError –

• When a null value sent to a non nullable field.
• When the value provided is not in the field choices.
• When the value provided is not in the self.internal_type

class asyncorm.models.ManyToManyField(db_column='', db_index=False, default=None, foreign_key=None, unique=False)

Bases: asyncorm.models.field.Field

args = ('db_column', 'db_index', 'default', 'foreign_key', 'unique')

creation_query()

Create the field’s database creation query.

Returns:query constructed Return type:str

creation_string = '\n {own_model} INTEGER REFERENCES {own_model} NOT NULL,\n {foreign_key} INTEGER REFERENCES {foreign_key} NOT NULL\n '

internal_type = (<class 'list'>, <class 'int'>)

required_kwargs = ['foreign_key']

validate(value)

Validate the value.

Parameters:value (self.internal_type) – value in the field Raises:AsyncOrmFieldError –

• When a null value sent to a non nullable field.
• When the value provided is not in the field choices.
• When the value provided is not in the self.internal_type

class asyncorm.models.Model(**kwargs)

Bases: asyncorm.models.models.BaseModel

DoesNotExist

alias of asyncorm.exceptions.AsyncOrmModelDoesNotExist

attr_names = {}

construct(data, deleted=False, subitems=None)

db_pk = 'id'

delete()

fields = {'id': <asyncorm.models.fields.AutoField object>}

id = <asyncorm.models.fields.AutoField object>

meta_items = ('ordering', 'unique_together', 'table_name')

objects = <asyncorm.models.models.ModelManager object>

ordering = None

orm_pk = 'id'

save(**kwargs)

table_name = ''

unique_together = []

class asyncorm.models.NumberField(**kwargs)

Bases: asyncorm.models.field.Field

class asyncorm.models.TextField(choices=None, db_column='', db_index=False, default=None, null=False, unique=False)

Bases: asyncorm.models.field.Field

args = ('choices', 'db_column', 'db_index', 'default', 'null', 'unique')

creation_string = 'text'

internal_type

alias of builtins.str

class asyncorm.models.TimeField(auto_now=False, choices=None, db_column='', db_index=False, default=None, null=False, strftime=None, unique=False)

Bases: asyncorm.models.fields.DateTimeField

creation_string = 'time'

internal_type

alias of datetime.time

strftime = '%H:%s'

class asyncorm.models.Uuid4Field(db_column='', db_index=False, null=False, unique=True, uuid_type='v4')

Bases: asyncorm.models.field.Field

args = ('db_column', 'db_index', 'null', 'unique', 'uuid_type')

creation_string

internal_type

alias of uuid.UUID

sanitize_data(value)

Sanitize the query before send to database.

class asyncorm.models.FloatField(choices=None, db_column='', db_index=False, default=None, null=False, unique=False)

Bases: asyncorm.models.fields.NumberField

args = ('choices', 'db_column', 'db_index', 'default', 'null', 'unique')

creation_string = 'double precision'

internal_type

alias of builtins.float