pydent.models.FieldValue

class pydent.models.FieldValue(name=None, role=None, parent_class=None, parent_id=None, field_type=None, sample=None, value=None, item=None, container=None)

Bases: pydent.models.field_value_mixins.FieldMixin, pydent.models.crud_mixin.JSONSaveMixin, pydent.models.crud_mixin.JSONDeleteMixin, pydent.base.ModelBase

A FieldValue model. One of the more complex models.

Changed in version 0.1.2: FieldValues no longer

have’wires_as_source’ or ‘wires_as_dest’ fields. Wires may only be accessed via plans only or via the FieldValue instance method ‘get_wires,’ which accesses the FieldValues operation and its Plan to obtain wires.

Parameters

• value –

• sample –

• container –

• item –

__init__(name=None, role=None, parent_class=None, parent_id=None, field_type=None, sample=None, value=None, item=None, container=None)

Parameters

• value –

• sample –

• container –

• item –

Methods

__init__([name, role, parent_class, …])	param value
add_data(data)	Initializes fake attributes that correspond to data.
anonymize()	Resets the primary key of the model and assigns a new rid.
append_to_many(name, model)	Appends a model to the many relationship.
choose_item([first])	Set the item associated with the field value.
compatible_items()	Find items compatible with the field value.
connect_to_session(session)	Connect model to a session.
copy([keep])	Provides a deepcopy of the model, but annonymizes the primary and global keys unless class is a metatype (e.g.
create_interface()	rtype Union[QueryInterface, BrowserInterface]
delete()
dump([only, include, ignore, …])	Dump (serialize) the Aquarium model instance to JSON.
find(session, model_id)	Finds a model instance by its model_id.
find_callback(model_name, model_id)	Finds a model using the model interface and model_id.
find_field_parent(model_name, model_id)	Callback for finding operation_type or sample_type.
get_deserialized(name)	Get deserialized data by name.
get_parent()
get_parent_key()
get_relationships()
get_server_model_name()
get_sid()	The FieldValues sample identifier.
get_tableized_name()
get_wires()
incoming_wires
interface(session)	Creates a model interface from this class and a session.
is_deserialized(name)	Check if a given key has already been deserialized.
load(*args, **kwargs)	Deserialize the data to a model.
load_from(data[, owner])	Create a new model instance from loaded attributes.
no_getter(*_)	Callback that always returns None.
one(session, query, **kwargs)	rtype ModelBase
one_callback(model_name, *args, **kwargs)	rtype ModelBase
outgoing_wires
print()
refresh()	Refresh this model from data from the server.
reload(data)	Reload model attributes from new data.
reset()	Resets the inputs of the field_value.
reset_field(name)	Reset the field descriptor to its placeholder value, returning the behavior.
save([do_reload])
set_aft()
set_allowable_field_type(allowable_field_type)
set_field_type(field_type)	Sets properties from a field_type.
set_operation(operation)
set_parent(model)
set_sample(sample)
set_value([value, sample, item, …])
show([pre])
valid_afts()
where(session, params)	Finds a list of models by some parameters.
where_callback(model_name, *args, **kwargs)	Finds models using a model interface and a set of parameters.

Attributes

DEFAULT_COPY_KEEP_UNANONYMOUS
GLOBAL_KEY
PRIMARY_KEY
SERVER_MODEL_NAME
FieldValue.allowable_field_type
FieldValue.array
FieldValue.child_sample_name
counter
FieldValue.field_type
fields
id
FieldValue.item
FieldValue.object_type
FieldValue.object_type_id
FieldValue.operation
FieldValue.parent_sample
predecessors
rid	rtype int
FieldValue.sample
session	The connected session instance.
FieldValue.sid
successors
FieldValue.wires_as_dest
FieldValue.wires_as_source

_check_for_session()

Raises error if model is not connected to a session.

:raises NoSessionError

classmethod _flatten_deserialized_data(models, memo)

Flattens all of the relationships found in the models, returning a rid: model dictionary.

Return type

dict

_get_data()

Return the model’s data.

_get_deserialized_data()

Return the deserialized model data.

_model_schema

alias of pydent.marshaller.base.FieldValueSchema

property _primary_key

Returns the primary key (e.g. ‘id’) or the rid if id does not exist or is None.

_rid_dict()

Dictionary of all models attached to this model keyed by their rid.

add_data(data)

Initializes fake attributes that correspond to data.

anonymize()

Resets the primary key of the model and assigns a new rid.

Metatypes cannot be annonymized.

Returns

self

append_to_many(name, model)

Appends a model to the many relationship.

Parameters

• name (str) – name of the relationship or attribute

• model (ModelBase) – model to append

Returns

None

Return type

None

choose_item(first=True)

Set the item associated with the field value.

compatible_items()

Find items compatible with the field value.

connect_to_session(session)

Connect model to a session.

Parameters

session (SessionABC) – the AqSession

Returns

None

Raises

• SessionAlreadySet – if session is already set

• NoSessionError – if session is not a SessionABC type

copy(keep=None)

Provides a deepcopy of the model, but annonymizes the primary and global keys unless class is a metatype (e.g. OperationType, SampleType, FieldType) or class name is found in list of ‘keep’.

By default, inventory classes such as Sample, Item, and Collection are ‘kept’.

This specific usecase is that when copying whole plans, that the integrity of the inventory used in the operations is maintained. These are the items that refer to physical inventory in the laboratory and are referred to by their rids, and so it is important to that any of these inventory are always maintain their rids. Meaning in the lab, their is only ONE instance of the inventory. In Trident and Aquarium, there is only ONE instance of inventory that is referred to by its rid.

Similarly, any metatype model must also maintain their rid.

Parameters

keep (Optional[bool]) – list of model classes (as a list of strings) to keep un-anonymous

Return type

ModelBase

Returns

copied model

dump(only=None, include=None, ignore=None, include_model_type=False, include_uri=False)

Dump (serialize) the Aquarium model instance to JSON.

Parameters

• only (Union[str, List[str], Tuple[str], Dict[str, Any], None]) – dump only the provided keys

• include (Union[str, List[str], Tuple[str], Dict[str, Any], None]) – include the provided nested dump keys

• ignore (Union[str, List[str], Tuple[str], Dict[str, Any], None]) – ignore the provided keys

• include_model_type (bool) – if True, include the model class type for each entry using the __model__ key

• include_uri (bool) – if True, include a URI using the session URL and the tableized model class name using the __uri__ key. If a session is not attached, look for the url namespace in the ModelBase.DEFAULT_NAMESPACE class attribute, as in http://aquarium.org/samples/10.

Return type

dict

Returns

serialized model instance

classmethod find(session, model_id)

Finds a model instance by its model_id.

Return type

ModelBase

find_callback(model_name, model_id)

Finds a model using the model interface and model_id.

Used to find models in model relationships.

Return type

ModelBase

find_field_parent(model_name, model_id)

Callback for finding operation_type or sample_type.

If parent_class does not match the expected nested model name (OperationType or SampleType), callback will return None

get_deserialized(name)

Get deserialized data by name.

Deprecated since version 0.1.5a7: method will be removed in 0.2. Use self._get_deserialized_data[name] instead.

Parameters

name – name of attribute

Returns

get_sid()

The FieldValues sample identifier.

classmethod interface(session)

Creates a model interface from this class and a session.

This method can be overridden in model definitions for special cases.

Return type

Union[QueryInterface, BrowserInterface]

is_deserialized(name)

Check if a given key has already been deserialized.

New in version 0.1.5a7: Method added

Parameters

name (str) – name of the attribute

Return type

bool

Returns

True if key has been deserialized.

classmethod load(*args, **kwargs)

Deserialize the data to a model.

Parameters

data (dict) – data to deserialize

Returns

the deserialized model

Return type

SchemaModel

classmethod load_from(data, owner=None)

Create a new model instance from loaded attributes.

‘obj’ should have a o

Return type

Union[List[ModelBase], ModelBase]

model_schema

alias of pydent.marshaller.base.FieldValueSchema

no_getter(*_)

Callback that always returns None.

refresh()

Refresh this model from data from the server.

Returns

self

Return type

self

reload(data)

Reload model attributes from new data.

Parameters

data (dict) – data to update model instance

Returns

model instance

Return type

ModelBase

reset()

Resets the inputs of the field_value.

reset_field(name)

Reset the field descriptor to its placeholder value, returning the behavior.

New in version 0.1.5a7: Method added to reset deserialized attributes

Parameters

name (str) – name of the attribute

Returns

None

property session

The connected session instance.

set_field_type(field_type)

Sets properties from a field_type.

property uri

Return a URI for this model using the attached session url and tableized model name. For example, http://aquarium.org/samples/. If no session is attached, use the ModelBase.DEFAULT_NAMESPACE key for the url.

Return type

str

Returns

the instance URI

classmethod where(session, params)

Finds a list of models by some parameters.

Return type

Optional[List[ModelBase]]

where_callback(model_name, *args, **kwargs)

Finds models using a model interface and a set of parameters.

Used to find models in model relationships.

Return type

Optional[List[ModelBase]]