First snapshot of trytond documentation refactoring

doc/topics/models/model.rst

+.. _topics-models-model:
+
+.. module:: trytond.model.model
+
+=====
+Model
+=====
+
+:class:`Model` Objects
+----------------------
+
+This is the base class that every kinds of model inherits. It defines common

[yangoon1, 2010/04/11 11:28:32]

still wrong

[ced, 2010/04/14 05:46:10]

I don't see what is wrong.

[yangoon1, 2010/04/14 10:03:33]

(every kind of model|all kinds of models)

+attributes of all models.
+
+Class attributes are:
+
+.. attribute:: Model._name
+
+    It contains the a unique name to reference the model throughout the
+    platform.
+
+.. attribute:: Model._inherits
+
+.. attribute:: Model._description
+
+    It contains a description of the model.
+
+.. attribute:: Model._rpc
+
+
+    It contains a dictionary with method name as key and a boolean as value. If
+    a method name is in the dictionary then it is allowed to call it remotely.
+    If the value is ``True`` then the transaction will be committed.
+
+.. attribute:: 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!'
+        }
+
+.. attribute:: Model._rec_name
+
+    It contains the name of the field used as name of records.
+
+.. attribute:: Model.id
+
+    The definition of the field ``id`` of records.
+
+Instance methods:
+
+.. method:: Model.init(cursor, module_name)
+
+    Register the model in ``ir.model`` and ``ir.model.field``.
+
+.. method:: Model.raise_user_error(cursor, error, [error_args, [error_description, [error_description_args, [raise_exception, [context]]]]])
+
+    Raise 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.
+
+.. method:: Model.raise_user_warning(cursor, user, warning_name, warning, [warning_args, [warning_description, [warning_description_args, [context]]]])
+
+    Raise an exception that will be displayed as a warning message on the
+    client, if the user has not yer bypassed it. ``warning_name`` is used to

[yangoon1, 2010/04/11 11:28:32]

not yet

+    uniquely identify the warning. Others parameters are like in
+    :meth:`Model.raise_user_error`.

[yangoon1, 2010/04/11 11:28:32]

Other parameters

what about raise_exception?

[ced, 2010/04/14 05:46:10]

I don't understand.

[yangoon1, 2010/04/14 10:03:33]

Others parameters are like in :meth:`Model.raise_user_error`. : but there
doesn't seem to be parameter raise_exception for raise_user_warning

+
+.. method:: Model.default_get(cursor, user, fields_names, [context, [with_rec_name]])
+
+    Return 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`(cursor, user,
+    [context])``. ``with_rec_name`` allow to add `rec_name` value for each
+    many2one field.
+
+.. method:: Model.fields_get(cursor, user, [fields_names, [context]])
+
+    Return the definition of each field on the model.