Models

Base models for dirty_models.

class dirty_models.models.BaseModel(data=None, flat=False, *args, **kwargs)

Bases: dirty_models.base.BaseData

Base model with dirty feature. It stores original data and saves modifications in other side.

clear()

Clears all the data in the object, keeping original data

clear_all()

Clears all the data in the object

clear_modified_data()

Clears only the modified data

copy()

Creates a copy of model

delete_attr_by_path(field_path)

It deletes fields looked up by field path. Field path is dot-formatted string path: parent_field.child_field.

Parameters:field_path (str) – field path. It allows * as wildcard.

delete_field_value(name)

Mark this field to be deleted

export_data()

Get the results with the modified_data

export_deleted_fields()

Resturns a list with any deleted fields form original data. In tree models, deleted fields on children will be appended.

export_modifications()

Returns model modifications.

export_modified_data()

Get the modified data

export_original_data()

Get the original data

flat_data()

Pass all the data from modified_data to original_data

get_1st_attr_by_path(field_path, **kwargs)

It returns first value looked up by field path. Field path is dot-formatted string path: parent_field.child_field.

Parameters:

• field_path (str) – field path. It allows * as wildcard.
• default – Default value if field does not exist. If it is not defined AttributeError exception will be raised.

Returns:

value

get_attrs_by_path(field_path, stop_first=False)

It returns list of values looked up by field path. Field path is dot-formatted string path: parent_field.child_field.

Parameters:

• field_path (list or None.) – field path. It allows * as wildcard.
• stop_first (bool) – Stop iteration on first value looked up. Default: False.

Returns:

A list of values or None it was a invalid path.

Return type:

list or None

classmethod get_default_data()

Returns a dictionary with default data.

Returns:dict

get_field_value(name)

Get the field value from the modified data or the original one

get_fields()

Returns used fields of model

get_original_field_value(name)

Returns original field value or None

classmethod get_structure()

Returns a dictionary with model field objects.

Returns:dict

import_data(data)

Set the fields established in data to the instance

import_deleted_fields(data)

Set data fields to deleted

is_modified()

Returns whether model is modified or not

is_modified_field(name)

Returns whether a field is modified or not

reset_attr_by_path(field_path)

It restores original values for fields looked up by field path. Field path is dot-formatted string path: parent_field.child_field.

Parameters:field_path (str) – field path. It allows * as wildcard.

reset_field_value(name)

Resets value of a field

set_field_value(name, value)

Set the value to the field modified_data

class dirty_models.models.DynamicModel(*args, **kwargs)

Bases: dirty_models.models.BaseDynamicModel

DynamicModel allow to create model with no structure. Each instance has its own derivated class from DynamicModels.

class dirty_models.models.FastDynamicModel(*args, **kwargs)

Bases: dirty_models.models.BaseDynamicModel

FastDynamicModel allow to create model with no structure.

get_current_structure()

Returns a dictionary with model field objects.

Returns:dict

get_validated_object(field_type, value)

Returns the value validated by the field_type

class dirty_models.models.HashMapModel(*args, **kwargs)

Bases: dirty_models.base.InnerFieldTypeMixin, dirty_models.models.BaseModel

Hash map model with dirty feature. It stores original data and saves modifications in other side.

copy()

Creates a copy of model

get_validated_object(value)

Returns the value validated by the field_type