Model

class trytond.model.Model([id[, **kwargs]])

This is the base class that every kind of model inherits. It defines common attributes of all models.

Class attributes are:

Model.__name__

It contains the a unique name to reference the model throughout the platform.

Model.__rpc__

It contains a dictionary with method name as key and an instance of trytond.rpc.RPC as value.

Model._error_messages

It contains a dictionary mapping keywords to an error message. By way of example:

_error_messages = {
    'recursive_categories': 'You can not create recursive categories!',
    'wrong_name': 'You can not use " / " in name field!'
}
Model._rec_name

It contains the name of the field used as name of records. The default value is ‘name’.

Model.id

The definition of the field id of records.

Model.__queue__

It returns a queue caller for the model. The called method will be pushed into the queue.

Class methods:

classmethod Model.__setup__()

Setup the class before adding into the trytond.pool.Pool.

classmethod Model.__post_setup__()

Setup the class after added into the trytond.pool.Pool.

classmethod Model.__register__(module_name)

Registers the model in ir.model and ir.model.field.

classmethod Model.raise_user_error(error[, error_args[, error_description[, error_description_args[, raise_exception]]]])

Raises an exception that will be displayed as an error message in the client. error is the key of the error message in _error_messages and error_args is the arguments for the “%”-based substitution of the error message. There is the same parameter for an additional description. The boolean raise_exception can be set to False to retrieve the error message strings.

classmethod Model.raise_user_warning(warning_name, warning[, warning_args[, warning_description[, warning_description_args]]])

Raises an exception that will be displayed as a warning message on the client, if the user has not yet bypassed it. warning_name is used to uniquely identify the warning. Others parameters are like in Model.raise_user_error().

Warning

It requires that the cursor will be commited as it stores state of the warning states by users.

classmethod Model.default_get(fields_names[, with_rec_name])

Returns a dictionary with the default values for each field in fields_names. Default values are defined by the returned value of each instance method with the pattern default_`field_name`(). with_rec_name allow to add rec_name value for each many2one field. The default_rec_name key in the context can be used to define the value of the Model._rec_name field.

classmethod Model.fields_get([fields_names])

Return the definition of each field on the model.

Instance methods:

Model.on_change(fieldnames)

Returns the list of changes by calling on_change method of each field.

Model.on_change_with(fieldnames)

Returns the new values of all fields by calling on_change_with method of each field.

Model.pre_validate()

This method is called by the client to validate the instance.

ModelView

class trytond.model.ModelView

It adds requirements to display a view of the model in the client.

Class attributes:

ModelView._buttons

It contains a dictionary with button name as key and the states dictionary for the button. This states dictionary will be used to generate the views containing the button.

Static methods:

static ModelView.button()

Decorate button method to check group access and rule.

static ModelView.button_action(action)

Same as ModelView.button() but return the action id of the XML id action.

static ModelView.button_change([*fields])

Same as ModelView.button() but for button that change values of the fields on client side (similar to on_change).

Warning

Only on instance methods.

Class methods:

classmethod ModelView.fields_view_get([view_id[, view_type[, toolbar]]])

Return a view definition used by the client. The definition is:

{
    'model': model name,
    'type': view type,
    'view_id': view id,
    'arch': XML description,
    'fields': {
        field name: {
            ...
        },
    },
    'field_childs': field for tree,
}
classmethod ModelView.view_toolbar_get()
Returns the model specific actions in a dictionary with keys:
  • print: a list of available reports
  • action: a list of available actions
  • relate: a list of available relations
classmethod ModelView.view_attributes()

Returns a list of XPath, attribute and value. Each element from the XPath will get the attribute set with the JSON encoded value.

ModelStorage

class trytond.model.ModelStorage

It adds storage capability.

Class attributes are:

ModelStorage.create_uid

The definition of the trytond.model.fields.Many2One field create_uid of records. It contains the id of the user who creates the record.

ModelStorage.create_date

The definition of the trytond.model.fields.DateTime field create_date of records. It contains the datetime of the creation of the record.

ModelStorage.write_uid

The definition of the trytond.model.fields.Many2One field write_uid of the records. It contains the id of the last user who writes on the record.

ModelStorage.write_date

The definition of the trytond.model.fields.DateTime field write_date of the records. It contains the datetime of the last write on the record.

ModelStorage.rec_name

The definition of the trytond.model.fields.Function field rec_name. It is used in the client to display the records with a single string.

ModelStorage._constraints

Warning

Deprecated, use trytond.model.ModelStorage.validate instead.

The list of constraints that each record must respect. The definition is:

[ (‘function name’, ‘error keyword’), … ]

where function name is the name of an instance or a class method of the which must return a boolean (False when the constraint is violated) and error keyword is a key of Model._error_messages.

Static methods:

static ModelStorage.default_create_uid()

Return the default value for create_uid.

static ModelStorage.default_create_date()

Return the default value for create_date.

Class methods:

classmethod ModelStorage.create(vlist)

Create records. vlist is list of dictionaries with fields names as key and created values as value and return the list of new instances.

classmethod ModelStorage.trigger_create(records)

Trigger create actions. It will call actions defined in ir.trigger if on_create is set and condition is true.

classmethod ModelStorage.read(ids, fields_names)

Return a list of dictionary for the record ids. The dictionary is composed of the fields as key and their values. The order of the returned list is not guaranteed.

classmethod ModelStorage.write(records, values[[, records, values], ...])

Write values on the list of records. values is a dictionary with fields names as key and writen values as value.

classmethod ModelStorage.trigger_write_get_eligibles(records)

Return eligible records for write actions by triggers. This dictionary is to pass to trigger_write().

classmethod ModelStorage.trigger_write(eligibles)

Trigger write actions. It will call actions defined in ir.trigger if on_write is set and condition was false before write() and true after.

classmethod ModelStorage.index_set_field(name)

Return the index sort order of the field set calls.

classmethod ModelStorage.delete(records)

Delete records.

classmethod ModelStorage.trigger_delete(records)

Trigger delete actions. It will call actions defined in ir.trigger if on_delete is set and condition is true.

classmethod ModelStorage.copy(records[, default])

Duplicate the records. default is a dictionary of default value per field name for the created records.

The values of default may be also callable that take a dictionary containing the fields and values of the record copied and return of the value.

The keys of default may use the dotted notation for the fields.One2Many to define the default to pass to its copy operation.

New records are returned following the input order.

classmethod ModelStorage.search(domain[, offset[, limit[, order[, count]]]])

Return a list of records that match the domain.

classmethod ModelStorage.search_count(domain)

Return the number of records that match the domain.

classmethod ModelStorage.search_read(domain[, offset[, limit[, order[, fields_names]]]])

Call search() and read() at once. Useful for the client to reduce the number of calls.

classmethod ModelStorage.search_rec_name(name, clause)

Searcher for the trytond.model.fields.Function field rec_name.

classmethod ModelStorage.search_global(cls, text)

Yield tuples (record, name, icon) for records matching text. It is used for the global search.

classmethod ModelStorage.browse(ids)

Return a list of record instance for the ids.

classmethod ModelStorage.export_data(records, fields_names)

Return a list of list of values for each records. The list of values follows fields_names. Relational fields are defined with / at any depth. Descriptor on fields are available by appending . and the name of the method on the field that returns the descriptor.

classmethod ModelStorage.import_data(fields_names, data)

Create records for all values in datas. The field names of values must be defined in fields_names. It returns a tuple containing: the number of records imported, the last values if failed, the exception if failed and the warning if failed.

classmethod ModelStorage.check_xml_record(records, values)

Verify if the records are originating from XML data. It is used to prevent modification of data coming from XML files. This method must be overiden to change this behavior.

classmethod ModelStorage.validate(records)

Validate the integrity of records after creation and modification. This method must be overridden to add validation and must raise an exception if validation fails.

Dual methods:

classmethod ModelStorage.save(records)

Save the modification made on the records.

Instance methods:

ModelStorage.get_rec_name(name)

Getter for the trytond.model.fields.Function field rec_name.

ModelSQL

class trytond.model.ModelSQL

It implements ModelStorage for an SQL database.

Class attributes are:

ModelSQL._table

The name of the database table which is mapped to the class. If not set, the value of Model._name is used with dots converted to underscores.

ModelSQL._order

The default order parameter of ModelStorage.search() method.

ModelSQL._order_name

The name of the field (or an SQL statement) on which the records must be sorted when sorting on a field refering to the model. If not set, ModelStorage._rec_name will be used.

ModelSQL._history

If true, all changes on records will be stored in a history table.

ModelSQL._sql_constraints

A list of SQL constraints that are added on the table:

[ (‘constraint name’, constraint, ‘error message key’), … ]
  • constraint name is the name of the SQL constraint in the database
  • constraint is an instance of Constraint
  • error message key is the key of _sql_error_messages
ModelSQL._sql_error_messages

Like Model._error_messages but for _sql_constraints

Class methods:

classmethod ModelSQL.__table__()

Return a SQL Table instance for the Model.

classmethod ModelSQL.__table_history__()

Return a SQL Table instance for the history of Model.

classmethod ModelSQL.__table_handler__([module_name[, history]])

Return a TableHandler for the Model.

classmethod ModelSQL.table_query()

Could be defined to use a custom SQL query instead of a table of the database. It should return a SQL FromItem.

Warning

By default all CRUD operation will raise an error on models implementing this method so the create, write and delete methods may also been overriden if needed.

classmethod ModelSQL.history_revisions(ids)

Return a sorted list of all revisions for ids. The list is composed of the date, id and username of the revision.

classmethod ModelSQL.restore_history(ids, datetime)

Restore the record ids from history at the specified date time. Restoring a record will still generate an entry in the history table.

Warning

No access rights are verified and the records are not validated.

classmethod ModelSQL.restore_history_before(ids, datetime)

Restore the record ids from history before the specified date time. Restoring a record will still generate an entry in the history table.

Warning

No access rights are verified and the records are not validated.

classmethod ModelSQL.search(domain[, offset[, limit[, order[, count[, query]]]]])

Return a list of records that match the domain.

If offset or limit are set, the result starts at the offset and has the length of the limit.

The order is a list of tuples defining the order of the result:

[ (‘field name’, ‘ASC’), (‘other field name’, ‘DESC’), … ]

The first element of the tuple is a field name of the model and the second is the sort ordering as ASC for ascending or DESC for descending. This second element may contain ‘NULLS FIRST’ or ‘NULLS LAST’ to sort null values before or after non-null values. If neither is specified the default behavior of the backend is used.

In case the field used is a fields.Many2One, it is also possible to use the dotted notation to sort on a specific field from the target record.

If count is set to True, then the result is the number of records.

If query is set to True, the the result is the SQL query.

classmethod ModelSQL.search_domain(domain[, active_test[, tables]])

Convert a domain into a SQL expression by returning the updated tables dictionary and a SQL expression.

Where tables is a nested dictionary containing the existing joins:

{
    None: (<Table invoice>, None),
    'party': {
        None: (<Table party>, <join_on sql expression>),
        'addresses': {
            None: (<Table address>, <join_on sql expression>),
            },
        },
    }

Constraint

class trytond.model.Constraint(table)

It represents a SQL constraint on a table of the database and it follows the API of the python-sql expression.

Instance attributes:

Constraint.table

The SQL Table on which the constraint is defined.

Check

class trytond.model.Check(table, expression)

It represents a check Constraint which enforce the validity of the expression.

Instance attributes:

Check.expression

The SQL expression to check.

Unique

class trytond.model.Unique(table, *columns)

It represents a unique Constraint which enforce the uniqeness of the group of columns with respect to all the rows in the table.

Instance attributes:

Unique.columns

The tuple of SQL Column instances.

Unique.operators

The tuple of Equal operators.

Exclude

class trytond.model.Exclude(table[, (expression, operator), ...[, where]])

It represents an exclude Constraint which guarantees that if any two rows are compared on the specified expression using the specified operator not all of these comparisons will return TRUE.

Instance attributes:

Exclude.excludes

The tuple of expression and operator.

Exclude.columns

The tuple of expressions.

Exclude.operators

The tuple of operators.

Exclude.where

The clause for which the exclusion applies.

Workflow

class trytond.model.Workflow

A Mix-in class to handle transition check.

Class attribute:

Workflow._transition_state

The name of the field that will be used to check state transition.

Workflow._transitions

A set containing tuples of from and to state.

Static methods:

static Workflow.transition(state)

Decorate method to filter ids for which the transition is valid and finally to update the state of the filtered ids.

ModelSingleton

class trytond.model.ModelSingleton

Modify ModelStorage into a singleton. This means that there will be only one record of this model. It is commonly used to store configuration value.

Class methods:

classmethod ModelSingleton.get_singleton()

Return the instance of the unique record if there is one.

DictSchemaMixin

class trytond.model.DictSchemaMixin

A mixin for the schema of trytond.model.fields.Dict field.

Class attributes are:

DictSchemaMixin.name

The definition of the trytond.model.fields.Char field for the name of the key.

DictSchemaMixin.string

The definition of the trytond.model.fields.Char field for the string of the key.

DictSchemaMixin.type_

The definition of the trytond.model.fields.Selection field for the type of the key. The available types are:

  • boolean
  • integer
  • char
  • float
  • numeric
  • date
  • datetime
  • selection
DictSchemaMixin.digits

The definition of the trytond.model.fields.Integer field for the digits number when the type is float or numeric.

DictSchemaMixin.domain

A domain constraint on the dictionary key that will be enforced only on the client side.

The key must be referenced by its name in the left operator of the domain. The PYSON evaluation context used to compute the domain is the dictionary value. Likewise the domain is tested using the dictionary value.

DictSchemaMixin.selection

The definition of the trytond.model.fields.Text field to store the couple of key and label when the type is selection. The format is a key/label separated by “:” per line.

DictSchemaMixin.selection_sorted

If the selection must be sorted on label by the client.

DictSchemaMixin.selection_json

The definition of the trytond.model.fields.Function field to return the JSON version of the selection.

Static methods:

static DictSchemaMixin.default_digits()

Return the default value for digits.

Class methods:

classmethod DictSchemaMixin.get_keys(records)

Return the definition of the keys for the records.

Instance methods:

DictSchemaMixin.get_selection_json(name)

Getter for the selection_json.

MatchMixin

class trytond.model.MatchMixin

A mixin to add to a Model a match method on pattern. The pattern is a dictionary with field name as key and the value to compare. The record matches the pattern if for all dictionary entries, the value of the record is equal or not defined.

Instance methods:

MatchMixin.match(pattern[, match_none])

Return if the instance match the pattern. If match_none is set None value of the instance will be compared.

UnionMixin

class trytond.model.UnionMixin

A mixin to create a ModelSQL which is the UNION of some ModelSQL’s. The ids of each models are sharded to be unique.

Static methods:

static UnionMixin.union_models()

Return the list of ModelSQL’s names

Class methods:

classmethod UnionMixin.union_shard(column, model)

Return a SQL expression that shards the column containing record id of model name.

classmethod UnionMixin.union_unshard(record_id)

Return the original instance of the record for the sharded id.

classmethod UnionMixin.union_column(name, field, table, Model)

Return the SQL column that corresponds to the field on the union model.

classmethod UnionMixin.union_columns(model)

Return the SQL table and columns to use for the UNION for the model name.

sequence_ordered

trytond.model.sequence_ordered([field_name[, field_label[, order]]])

Retuns a mixin class which defines the order of a ModelSQL with an trytond.model.fields.Integer field. field_name indicates the name of the field to be created and its default values is sequence. field_label defines the label which will be used by the field and defaults to Sequence. Order specifies the order direction and defaults to ASC NULLS FIRST.

MultiValueMixin

class trytond.model.MultiValueMixin

A mixin for Model to help having trytond.model.fields.MultiValue fields with multi-values on a ValueMixin. The values are stored by creating one record per pattern. The patterns are the same as those on MatchMixin.

Class methods:

classmethod MultiValueMixin.multivalue_model(field)

Return the ValueMixin on which the values are stored for the field name. The default is class name suffixed by the field name.

classmethod MultiValueMixin.setter_multivalue(records, name, value, **pattern)

The setter method for the trytond.model.fields.Function fields.

Instance methods:

MultiValueMixin.multivalue_records(field)

Return the list of all ValueMixin records linked to the instance. By default, it returns the value of the first found trytond.model.fields.One2Many linked to the multivalue model or all the records of this one.

MultiValueMixin.multivalue_record(field, **pattern)

Return a new record of ValueMixin linked to the instance.

MultiValueMixin.get_multivalue(name, **pattern)

Return the value of the field name for the pattern.

MultiValueMixin.set_multivalue(name, value, [save, ]**pattern)

Store the value of the field name for the pattern. If save is true, it will be stored in the database, otherwise the modified ValueMixin records are returned unsaved. save is true by default.

Warning

To customize the pattern, both methods must be override the same way.

ValueMixin

class trytond.model.ValueMixin

A mixin to store the values of MultiValueMixin.

DeactivableMixin

class trytond.model.DeactivableMixin

A mixin to add soft deletion to the model.

Class attributes are:

DictSchemaMixin.active

The definition of the trytond.model.fields.Boolean field to store soft deletion state. False values will be consideres as soft deletion.

tree

trytond.model.tree([parent[, name[, separator]]])

Returns a mixin class TreeMixin. parent indicates the name of the field that defines the parent of the tree and its default value is parent. name indicates the name of the field that defines the name of the record and its default value is name. If separator is set, the ModelStorage.get_rec_name() constructs the name by concatenating each parent names using it as separator and ModelStorage.search_rec_name() is adapted to search across the tree.

class trytond.model.TreeMixin
classmethod TreeMixin.check_recursion(records)

Helper method that checks if there is no recursion in the tree defined by tree().