Modules

Modules#

The modules of Tryton extend the functionality of the platform. The server comes by default with only basic functionality included in these modules: ir, res.

Module Structure#

A module is a directory in trytond/modules which contains at least two files:

__init__.py

A Tryton module must be a Python module.

tryton.cfg

A Configuration file that describes the Tryton module.

__init__.py file#

It is the Python __init__.py to define a module.

tryton.cfg file#

This is a configuration file that uses the ConfigParser format and must contain a [tryton] section with the following keys:

version

The version number of the module.

Note

When using the setup.py generated by the cookiecutter template, the major and minor part of this version (X.Y.*) must match the version of the Tryton server the module is for.

depends

A one per line list of modules on which this module depends.

extras_depend

A one per line list of modules on which this module may depend.

xml

The one per line list of the XML files of the module. They will be loaded in the given order when the module is activated or updated.

It may contain some [register] or [register <module> <module>] sections with the keys model, wizard and report defining the type_ and qualified name of class relative to the module as a one per line list to pass to register().

Note

The <module> in the section name set the depends.

And it also may contain a [register_mixin] which define the pair of qualified name relative to the module of mixin and subsclass to pass to register_mixin().

Here is an example:

[tryton]
version=0.0.1
depends:
    country
    ir
    res
xml:
    party.xml
    category.xml
    address.xml
    contact_mechanism.xml

[register]
model:
    category.Category
    party.Party
    address.Address
    contact_mechanism.ContactMechanism
wizard:
    party.Replace

Python Files#

The Python files define the models for the modules.

XML Files#

The XML files define the data that is inserted into the database on activation.

The trytond/tryton.rng and trytond/tryton.rnc files contain a RELAX NG XML schema for these files in XML syntax and compact syntax respectively.

The following snippet gives a first idea of what an XML file looks:

<?xml version="1.0"?>
<tryton>
    <data>
        <record model="res.group" id="group_party_admin">
            <field name="name">Party Administration</field>
        </record>
        <record model="res.user-res.group"
            id="user_admin_group_party_admin">
            <field name="user" ref="res.user_admin"/>
            <field name="group" ref="group_party_admin"/>
        </record>

        <menuitem
            name="Party Management"
            sequence="0"
            id="menu_party"
            icon="tryton-users"/>

        <record model="ir.ui.view" id="party_view_tree">
            <field name="model">party.party</field>
            <field name="type">tree</field>
            <field name="arch">
                <![CDATA[
                <tree string="Parties">
                    <field name="code"/>
                    <field name="name"/>
                    <field name="lang"/>
                    <field name="vat_code"/>
                    <field name="active" tree_invisible="1"/>
                    <field name="vat_country" tree_invisible="1"/>
                    <field name="vat_number" tree_invisible="1"/>
                </tree>
                ]]>
            </field>
        </record>
    </data>
</tryton>

Here is the list of valid tags:

tryton

The root tag of the XML.

data

Define a set of data inside the file. It can have the attributes:

noupdate

Prevent the framework to update the records,

depends

Import data only if all modules in the comma separated module list value are activated,

grouped

Create records at the end with a grouped call.

language

Import data only if the language is translatable.

record

Create a record of the model defined by the attribute model in the database. The id attribute can be used to refer to the record later in any XML file.

field

Set the value of the field with the name defined by the attribute name. Here is the list of valid attributes:

search

Only for relation fields. It contains a domain which is used to search for the value to use. The first value found will be used.

ref

Only for relation fields. It contains an XML id of the relation to use as value. It must be prefixed by the module name with an ending dot, if the record is defined in an other module.

eval

Python code to evaluate and use result as value. The following expressions are available:

time

The python time module.

version

The current Tryton version.

ref

A function that converts an XML id into a database id.

Decimal

The python Decimal object.

datetime

The python datetime module.

pyson

Convert the evaluated value into PYSON string.

depends

Set value only if all modules in the comma separated module list value are activated.

Note

Field content is treated as a string. So for fields that require other types, it is required to use the eval attribute.

menuitem

Shortcut to create Menu records. Here is the list of attributes:

id

The id of the menu.

name

The name of the menu.

icon

The icon of the menu.

sequence

The sequence value used to order the menu entries.

parent

The XML id of the parent menu.

action

The XML id of the action linked to the menu.

groups

A list of XML id of group, that have access to the menu, separated by commas.

active

A boolean telling if the menu is active or not.

Contents