453 lines
18 KiB
Python
453 lines
18 KiB
Python
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
|
# this repository contains the full copyright notices and license terms.
|
|
|
|
import copy
|
|
import collections
|
|
import warnings
|
|
from functools import total_ordering
|
|
|
|
from trytond.model import fields
|
|
from trytond.error import WarningErrorMixin
|
|
from trytond.pool import Pool, PoolBase
|
|
from trytond.pyson import PYSONEncoder
|
|
from trytond.transaction import Transaction
|
|
from trytond.url import URLMixin
|
|
from trytond.rpc import RPC
|
|
|
|
__all__ = ['Model']
|
|
|
|
|
|
@total_ordering
|
|
class Model(WarningErrorMixin, URLMixin, PoolBase):
|
|
"""
|
|
Define a model in Tryton.
|
|
"""
|
|
_rec_name = 'name'
|
|
|
|
id = fields.Integer('ID', readonly=True)
|
|
|
|
@classmethod
|
|
def __setup__(cls):
|
|
super(Model, cls).__setup__()
|
|
cls.__rpc__ = {
|
|
'default_get': RPC(),
|
|
'fields_get': RPC(),
|
|
'pre_validate': RPC(instantiate=0),
|
|
}
|
|
cls._error_messages = {}
|
|
|
|
# Copy fields and update depends
|
|
for attr in dir(cls):
|
|
if attr.startswith('_'):
|
|
continue
|
|
if not isinstance(getattr(cls, attr), fields.Field):
|
|
continue
|
|
field_name = attr
|
|
field = getattr(cls, field_name)
|
|
# Copy the original field definition to prevent side-effect with
|
|
# the mutable attributes
|
|
for parent_cls in cls.__mro__:
|
|
parent_field = getattr(parent_cls, field_name, None)
|
|
if isinstance(parent_field, fields.Field):
|
|
field = parent_field
|
|
field = copy.deepcopy(field)
|
|
setattr(cls, field_name, field)
|
|
|
|
@classmethod
|
|
def __post_setup__(cls):
|
|
super(Model, cls).__post_setup__()
|
|
|
|
# Set _fields
|
|
cls._fields = {}
|
|
for attr in dir(cls):
|
|
if attr.startswith('_'):
|
|
continue
|
|
if isinstance(getattr(cls, attr), fields.Field):
|
|
cls._fields[attr] = getattr(cls, attr)
|
|
|
|
# Set _defaults
|
|
cls._defaults = {}
|
|
fields_names = cls._fields.keys()
|
|
for field_name in fields_names:
|
|
default_method = getattr(cls, 'default_%s' % field_name, False)
|
|
if isinstance(default_method, collections.Callable):
|
|
cls._defaults[field_name] = default_method
|
|
|
|
for k in cls._defaults:
|
|
assert k in cls._fields, \
|
|
'Default function defined in %s but field %s does not exist!' \
|
|
% (cls.__name__, k,)
|
|
|
|
# Set name to fields
|
|
for name, field in cls._fields.iteritems():
|
|
if field.name is None:
|
|
field.name = name
|
|
else:
|
|
assert field.name == name, (
|
|
'Duplicate fields on %s: %s, %s'
|
|
% (cls, field.name, name))
|
|
|
|
@classmethod
|
|
def _get_name(cls):
|
|
'''
|
|
Returns the first non-empty line of the model docstring.
|
|
'''
|
|
assert cls.__doc__, '%s has no docstring' % cls
|
|
lines = cls.__doc__.splitlines()
|
|
for line in lines:
|
|
line = line.strip()
|
|
if line:
|
|
return line
|
|
|
|
@classmethod
|
|
def __register__(cls, module_name):
|
|
"""
|
|
Add model in ir.model and ir.model.field.
|
|
"""
|
|
super(Model, cls).__register__(module_name)
|
|
pool = Pool()
|
|
Translation = pool.get('ir.translation')
|
|
Model_ = pool.get('ir.model')
|
|
ModelField = pool.get('ir.model.field')
|
|
|
|
model_id = Model_.register(cls, module_name)
|
|
ModelField.register(cls, module_name, model_id)
|
|
|
|
Translation.register_model(cls, module_name)
|
|
Translation.register_fields(cls, module_name)
|
|
Translation.register_error_messages(cls, module_name)
|
|
|
|
@classmethod
|
|
def default_get(cls, fields_names, with_rec_name=True):
|
|
'''
|
|
Return a dict with the default values for each field in fields_names.
|
|
If with_rec_name is True, rec_name will be added.
|
|
'''
|
|
pool = Pool()
|
|
Property = pool.get('ir.property')
|
|
value = {}
|
|
|
|
# get the default values defined in the object
|
|
for field_name in fields_names:
|
|
if field_name in cls._defaults:
|
|
value[field_name] = cls._defaults[field_name]()
|
|
field = cls._fields[field_name]
|
|
if (field._type == 'boolean'
|
|
and field_name not in value):
|
|
value[field_name] = False
|
|
if isinstance(field, fields.Property):
|
|
value[field_name] = Property.get(field_name, cls.__name__)
|
|
if (with_rec_name
|
|
and field._type in ('many2one',)
|
|
and value.get(field_name)):
|
|
Target = pool.get(field.model_name)
|
|
if 'rec_name' in Target._fields:
|
|
value[field_name + '.rec_name'] = Target(
|
|
value[field_name]).rec_name
|
|
|
|
if not with_rec_name:
|
|
for field in value.keys():
|
|
if field.endswith('.rec_name'):
|
|
del value[field]
|
|
return value
|
|
|
|
@classmethod
|
|
def fields_get(cls, fields_names=None):
|
|
"""
|
|
Return the definition of each field on the model.
|
|
"""
|
|
res = {}
|
|
pool = Pool()
|
|
Translation = pool.get('ir.translation')
|
|
FieldAccess = pool.get('ir.model.field.access')
|
|
ModelAccess = pool.get('ir.model.access')
|
|
|
|
# Add translation to cache
|
|
language = Transaction().language
|
|
trans_args = []
|
|
for field in (x for x in cls._fields.keys()
|
|
if ((not fields_names) or x in fields_names)):
|
|
trans_args.append((cls.__name__ + ',' + field, 'field', language,
|
|
None))
|
|
trans_args.append((cls.__name__ + ',' + field, 'help', language,
|
|
None))
|
|
if hasattr(cls._fields[field], 'selection'):
|
|
if (isinstance(cls._fields[field].selection, (tuple, list))
|
|
and ((hasattr(cls._fields[field],
|
|
'translate_selection')
|
|
and cls._fields[field].translate_selection)
|
|
or not hasattr(cls._fields[field],
|
|
'translate_selection'))):
|
|
sel = cls._fields[field].selection
|
|
for (key, val) in sel:
|
|
trans_args.append((cls.__name__ + ',' + field,
|
|
'selection', language, val))
|
|
Translation.get_sources(trans_args)
|
|
|
|
encoder = PYSONEncoder()
|
|
|
|
accesses = FieldAccess.get_access([cls.__name__])[cls.__name__]
|
|
for field in (x for x in cls._fields.keys()
|
|
if ((not fields_names) or x in fields_names)):
|
|
res[field] = {
|
|
'type': cls._fields[field]._type,
|
|
'name': field,
|
|
}
|
|
for arg in (
|
|
'string',
|
|
'readonly',
|
|
'states',
|
|
'size',
|
|
'required',
|
|
'translate',
|
|
'help',
|
|
'select',
|
|
'on_change',
|
|
'add_remove',
|
|
'on_change_with',
|
|
'autocomplete',
|
|
'sort',
|
|
'datetime_field',
|
|
'loading',
|
|
'filename',
|
|
'selection_change_with',
|
|
'domain',
|
|
'converter',
|
|
):
|
|
if getattr(cls._fields[field], arg, None) is not None:
|
|
value = getattr(cls._fields[field], arg)
|
|
if isinstance(value, set):
|
|
value = list(value)
|
|
else:
|
|
value = copy.copy(value)
|
|
res[field][arg] = value
|
|
if not accesses.get(field, {}).get('write', True):
|
|
res[field]['readonly'] = True
|
|
if res[field].get('states') and \
|
|
'readonly' in res[field]['states']:
|
|
del res[field]['states']['readonly']
|
|
for arg in ('digits', 'invisible'):
|
|
if hasattr(cls._fields[field], arg) \
|
|
and getattr(cls._fields[field], arg):
|
|
res[field][arg] = copy.copy(getattr(cls._fields[field],
|
|
arg))
|
|
if (isinstance(cls._fields[field],
|
|
(fields.Function, fields.One2Many))
|
|
and not getattr(cls, 'order_%s' % field, None)):
|
|
res[field]['sortable'] = False
|
|
if ((isinstance(cls._fields[field], fields.Function)
|
|
and not cls._fields[field].searcher)
|
|
or (cls._fields[field]._type in ('binary', 'sha'))
|
|
or (isinstance(cls._fields[field], fields.Property)
|
|
and isinstance(cls._fields[field]._field,
|
|
fields.Many2One))):
|
|
res[field]['searchable'] = False
|
|
else:
|
|
res[field]['searchable'] = True
|
|
|
|
if Transaction().context.get('language'):
|
|
# translate the field label
|
|
res_trans = Translation.get_source(
|
|
cls.__name__ + ',' + field, 'field',
|
|
Transaction().context['language'])
|
|
if res_trans:
|
|
res[field]['string'] = res_trans
|
|
help_trans = Translation.get_source(
|
|
cls.__name__ + ',' + field, 'help',
|
|
Transaction().context['language'])
|
|
if help_trans:
|
|
res[field]['help'] = help_trans
|
|
|
|
if hasattr(cls._fields[field], 'selection'):
|
|
if isinstance(cls._fields[field].selection, (tuple, list)):
|
|
sel = copy.copy(cls._fields[field].selection)
|
|
if (Transaction().context.get('language')
|
|
and ((hasattr(cls._fields[field],
|
|
'translate_selection')
|
|
and cls._fields[field].translate_selection)
|
|
or not hasattr(cls._fields[field],
|
|
'translate_selection'))):
|
|
# translate each selection option
|
|
sel2 = []
|
|
for (key, val) in sel:
|
|
val2 = Translation.get_source(
|
|
cls.__name__ + ',' + field, 'selection',
|
|
language, val)
|
|
sel2.append((key, val2 or val))
|
|
sel = sel2
|
|
res[field]['selection'] = sel
|
|
else:
|
|
# call the 'dynamic selection' function
|
|
res[field]['selection'] = copy.copy(
|
|
cls._fields[field].selection)
|
|
if res[field]['type'] in (
|
|
'one2many',
|
|
'many2many',
|
|
'many2one',
|
|
'one2one',
|
|
):
|
|
if hasattr(cls._fields[field], 'model_name'):
|
|
relation = copy.copy(cls._fields[field].model_name)
|
|
else:
|
|
relation = copy.copy(
|
|
cls._fields[field].get_target().__name__)
|
|
res[field]['relation'] = relation
|
|
res[field]['context'] = copy.copy(cls._fields[field].context)
|
|
res[field]['create'] = accesses.get(field, {}).get('create',
|
|
True)
|
|
res[field]['delete'] = accesses.get(field, {}).get('delete',
|
|
True)
|
|
if res[field]['type'] == 'one2many' \
|
|
and getattr(cls._fields[field], 'field', None):
|
|
res[field]['relation_field'] = copy.copy(
|
|
cls._fields[field].field)
|
|
if res[field]['type'] == 'many2one':
|
|
target = cls._fields[field].get_target()
|
|
relation_fields = []
|
|
for target_name, target_field in target._fields.iteritems():
|
|
if (target_field._type == 'one2many'
|
|
and target_field.model_name == cls.__name__
|
|
and target_field.field == field):
|
|
relation_fields.append(target_name)
|
|
# Set relation_field only if there is no ambiguity
|
|
if len(relation_fields) == 1:
|
|
res[field]['relation_field'], = relation_fields
|
|
if res[field]['type'] in ('datetime', 'time'):
|
|
res[field]['format'] = copy.copy(cls._fields[field].format)
|
|
if res[field]['type'] == 'selection':
|
|
res[field]['context'] = copy.copy(cls._fields[field].context)
|
|
if res[field]['type'] == 'dict':
|
|
res[field]['schema_model'] = cls._fields[field].schema_model
|
|
res[field]['domain'] = copy.copy(cls._fields[field].domain)
|
|
res[field]['context'] = copy.copy(cls._fields[field].context)
|
|
res[field]['create'] = accesses.get(field, {}).get('create',
|
|
True)
|
|
res[field]['delete'] = accesses.get(field, {}).get('delete',
|
|
True)
|
|
|
|
# convert attributes into pyson
|
|
for attr in ('states', 'domain', 'context', 'digits', 'size',
|
|
'add_remove', 'format'):
|
|
if attr in res[field]:
|
|
res[field][attr] = encoder.encode(res[field][attr])
|
|
|
|
for i in res.keys():
|
|
# filter out fields which aren't in the fields_names list
|
|
if fields_names:
|
|
if i not in fields_names:
|
|
del res[i]
|
|
elif not ModelAccess.check_relation(cls.__name__, i, mode='read'):
|
|
del res[i]
|
|
return res
|
|
|
|
def pre_validate(self):
|
|
pass
|
|
|
|
def __init__(self, id=None, **kwargs):
|
|
super(Model, self).__init__()
|
|
if id is not None:
|
|
id = int(id)
|
|
self.__dict__['id'] = id
|
|
self._values = None
|
|
parent_values = {}
|
|
for name, value in kwargs.iteritems():
|
|
if not name.startswith('_parent_'):
|
|
setattr(self, name, value)
|
|
else:
|
|
parent_values[name] = value
|
|
for name, value in parent_values.iteritems():
|
|
parent_name, field = name.split('.', 1)
|
|
parent_name = parent_name[8:] # Strip '_parent_'
|
|
parent = getattr(self, parent_name, None)
|
|
if parent is not None:
|
|
setattr(parent, field, value)
|
|
else:
|
|
setattr(self, parent_name, {field: value})
|
|
self._init_values = self._values.copy() if self._values else None
|
|
|
|
def __getattr__(self, name):
|
|
if name == 'id':
|
|
return self.__dict__['id']
|
|
elif self._values and name in self._values:
|
|
return self._values.get(name)
|
|
raise AttributeError("'%s' Model has no attribute '%s': %s"
|
|
% (self.__name__, name, self._values))
|
|
|
|
def __setattr__(self, name, value):
|
|
if name == 'id':
|
|
self.__dict__['id'] = value
|
|
return
|
|
super(Model, self).__setattr__(name, value)
|
|
|
|
def __getitem__(self, name):
|
|
warnings.warn('Use __getattr__ instead of __getitem__',
|
|
DeprecationWarning, stacklevel=2)
|
|
return getattr(self, name)
|
|
|
|
def __contains__(self, name):
|
|
return name in self._fields
|
|
|
|
def __int__(self):
|
|
return int(self.id)
|
|
|
|
def __str__(self):
|
|
return '%s,%s' % (self.__name__, self.id)
|
|
|
|
def __unicode__(self):
|
|
return u'%s,%s' % (self.__name__, self.id)
|
|
|
|
def __repr__(self):
|
|
if self.id < 0:
|
|
return "Pool().get('%s')(**%s)" % (self.__name__,
|
|
repr(self._default_values))
|
|
else:
|
|
return "Pool().get('%s')(%s)" % (self.__name__, self.id)
|
|
|
|
def __eq__(self, other):
|
|
if not isinstance(other, Model):
|
|
return NotImplemented
|
|
elif self.id is None or other.id is None:
|
|
return id(self) == id(other)
|
|
return (self.__name__, self.id) == (other.__name__, other.id)
|
|
|
|
def __lt__(self, other):
|
|
if not isinstance(other, Model) or self.__name__ != other.__name__:
|
|
return NotImplemented
|
|
return self.id < other.id
|
|
|
|
def __ne__(self, other):
|
|
return not self == other
|
|
|
|
def __hash__(self):
|
|
return hash((self.__name__, self.id))
|
|
|
|
def __nonzero__(self):
|
|
return True
|
|
|
|
@property
|
|
def _default_values(self):
|
|
"""Return the values not stored.
|
|
By default, the value of a field is its internal representation except:
|
|
- for Many2One and One2One field: the id
|
|
- for Reference field: the string model,id
|
|
- for Many2Many: the list of ids
|
|
- for One2Many: the list of `_default_values`
|
|
"""
|
|
values = {}
|
|
if self._values:
|
|
for fname, value in self._values.iteritems():
|
|
field = self._fields[fname]
|
|
if field._type in ('many2one', 'one2one', 'reference'):
|
|
if value:
|
|
if field._type == 'reference':
|
|
value = str(value)
|
|
else:
|
|
value = value.id
|
|
elif field._type in ('one2many', 'many2many'):
|
|
if field._type == 'one2many':
|
|
value = [r._default_values for r in value]
|
|
else:
|
|
value = [r.id for r in value]
|
|
values[fname] = value
|
|
return values
|