# 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 inspect import copy from trytond.i18n import gettext from trytond.model.fields.field import Field from trytond.tools import is_instance_method from trytond.transaction import Transaction class Function(Field): ''' Define function field (any). ''' def __init__(self, field, getter, setter=None, searcher=None, loading='lazy'): ''' :param field: The field of the function. :param getter: The name of the function for getting values. :param setter: The name of the function to set value. :param searcher: The name of the function to search. :param loading: Define how the field must be loaded: ``lazy`` or ``eager``. ''' assert isinstance(field, Field) self._field = field self._type = field._type self.getter = getter self.setter = setter if not self.setter: self._field.readonly = True self.searcher = searcher assert loading in ('lazy', 'eager'), \ 'loading must be "lazy" or "eager"' self.loading = loading __init__.__doc__ += Field.__init__.__doc__ def __copy__(self): return Function(copy.copy(self._field), self.getter, setter=self.setter, searcher=self.searcher, loading=self.loading) def __deepcopy__(self, memo): return Function(copy.deepcopy(self._field, memo), self.getter, setter=self.setter, searcher=self.searcher, loading=self.loading) def __getattr__(self, name): return getattr(self._field, name) def __getitem__(self, name): return self._field[name] def __setattr__(self, name, value): if name in ('_field', '_type', 'getter', 'setter', 'searcher', 'name'): object.__setattr__(self, name, value) if name != 'name': return setattr(self._field, name, value) def set_rpc(self, model): self._field.set_rpc(model) def sql_format(self, value): return self._field.sql_format(value) def sql_type(self): return None def convert_domain(self, domain, tables, Model): name, operator, value = domain[:3] assert name.startswith(self.name) method = getattr(Model, 'domain_%s' % self.name, None) if method: return method(domain, tables) if self.searcher: return getattr(Model, self.searcher)(self.name, domain) raise NotImplementedError(gettext( 'ir.msg_search_function_missing', **Model.__names__(self.name))) def get(self, ids, Model, name, values=None): ''' Call the getter. If the function has ``names`` in the function definition then it will call it with a list of name. ''' with Transaction().set_context(_check_access=False): method = getattr(Model, self.getter) instance_method = is_instance_method(Model, self.getter) signature = inspect.signature(method) uses_names = 'names' in signature.parameters def call(name): records = Model.browse(ids) if not instance_method: return method(records, name) else: return dict((r.id, method(r, name)) for r in records) if isinstance(name, list): names = name if uses_names: return call(names) return dict((name, call(name)) for name in names) else: if uses_names: name = [name] return call(name) def set(self, Model, name, ids, value, *args): ''' Call the setter. ''' with Transaction().set_context(_check_access=False): if self.setter: # TODO change setter API to use sequence of records, value setter = getattr(Model, self.setter) args = iter((ids, value) + args) for ids, value in zip(args, args): setter(Model.browse(ids), name, value) else: raise NotImplementedError(gettext( 'ir.msg_setter_function_missing', **Model.__names__(self.name))) def __set__(self, inst, value): self._field.__set__(inst, value) def definition(self, model, language): definition = self._field.definition(model, language) definition.update(super().definition(model, language)) definition['searchable'] &= ( bool(self.searcher) or hasattr(model, 'domain_' + self.name)) definition['sortable'] &= hasattr(model, 'order_' + self.name) return definition class MultiValue(Function): def __init__(self, field, loading='lazy'): super(MultiValue, self).__init__( field, '_multivalue_getter', setter='_multivalue_setter', loading=loading) def __copy__(self): return MultiValue(copy.copy(self._field), loading=self.loading) def __deepcopy__(self, memo): return MultiValue( copy.deepcopy(self._field, memo), loading=self.loading)