/usr/lib/python3/dist-packages/odoorpc/fields.py is in python3-odoorpc 0.5.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 | # -*- coding: UTF-8 -*-
##############################################################################
#
# OdooRPC
# Copyright (C) 2014 Sébastien Alix.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
"""This module contains classes representing the fields supported by Odoo.
A field is a Python descriptor which defines getter/setter methods for
its related attribute.
"""
import sys
import datetime
#from odoorpc import error
from odoorpc.models import Model, IncrementalRecords
def is_int(value):
"""Return `True` if ``value`` is an integer."""
if isinstance(value, bool):
return False
try:
int(value)
return True
except ValueError:
return False
# Python 2
if sys.version_info[0] < 3:
def is_string(value):
"""Return `True` if ``value`` is a string."""
return isinstance(value, basestring)
# Python >= 3
else:
def is_string(value):
"""Return `True` if ``value`` is a string."""
return isinstance(value, str)
def odoo_tuple_in(iterable):
"""Return `True` if `iterable` contains an expected tuple like
``(6, 0, IDS)`` (and so on).
>>> odoo_tuple_in([0, 1, 2]) # Simple list
False
>>> odoo_tuple_in([(6, 0, [42])]) # List of tuples
True
>>> odoo_tuple_in([[1, 42]]) # List of lists
True
"""
if not iterable:
return False
def is_odoo_tuple(elt):
"""Return `True` if `elt` is a Odoo special tuple."""
try:
return elt[:1][0] in [1, 2, 3, 4, 5] \
or elt[:2] in [(6, 0), [6, 0], (0, 0), [0, 0]]
except (TypeError, IndexError):
return False
return any(is_odoo_tuple(elt) for elt in iterable)
def tuples2ids(tuples, ids):
"""Update `ids` according to `tuples`, e.g. (3, 0, X), (4, 0, X)..."""
for value in tuples:
if value[0] == 6 and value[2]:
ids = value[2]
elif value[0] == 5:
ids[:] = []
elif value[0] == 4 and value[1] and value[1] not in ids:
ids.append(value[1])
elif value[0] == 3 and value[1] and value[1] in ids:
ids.remove(value[1])
return ids
def records2ids(iterable):
"""Replace records contained in `iterable` with their corresponding IDs:
>>> groups = list(odoo.env.user.groups_id)
>>> records2ids(groups)
[1, 2, 3, 14, 17, 18, 19, 7, 8, 9, 5, 20, 21, 22, 23]
"""
def record2id(elt):
"""If `elt` is a record, return its ID."""
if isinstance(elt, Model):
return elt.id
return elt
return [record2id(elt) for elt in iterable]
class BaseField(object):
"""Field which all other fields inherit.
Manage common metadata.
"""
def __init__(self, name, data):
self.name = name
self.type = 'type' in data and data['type'] or False
self.string = 'string' in data and data['string'] or False
self.size = 'size' in data and data['size'] or False
self.required = 'required' in data and data['required'] or False
self.readonly = 'readonly' in data and data['readonly'] or False
self.help = 'help' in data and data['help'] or False
self.states = 'states' in data and data['states'] or False
def __get__(self, instance, owner):
pass
def __set__(self, instance, value):
"""Each time a record is modified, it is marked as dirty
in the environment.
"""
instance.env.dirty.add(instance)
if instance._odoo.config.get('auto_commit'):
instance.env.commit()
def __str__(self):
"""Return a human readable string representation of the field."""
attrs = ['string', 'relation', 'required', 'readonly', 'size', 'domain']
attrs_rep = []
for attr in attrs:
if hasattr(self, attr):
value = getattr(self, attr)
if value:
if is_string(value):
attrs_rep.append("{0}='{1}'".format(attr, value))
else:
attrs_rep.append("{0}={1}".format(attr, value))
attrs_rep = ", ".join(attrs_rep)
return "{0}({1})".format(self.type, attrs_rep)
def check_value(self, value):
"""Check the validity of a value for the field."""
#if self.readonly:
# raise error.Error(
# "'{field_name}' field is readonly".format(
# field_name=self.name))
if value and self.size:
if not is_string(value):
raise ValueError("Value supplied has to be a string")
if len(value) > self.size:
raise ValueError(
"Lenght of the '{0}' is limited to {1}".format(
self.name, self.size))
if not value and self.required:
raise ValueError("'{0}' field is required".format(self.name))
return value
def store(self, record, value):
"""Store the value in the record."""
record._values[self.name][record.id] = value
class Binary(BaseField):
"""Equivalent of the `fields.Binary` class."""
def __init__(self, name, data):
super(Binary, self).__init__(name, data)
def __get__(self, instance, owner):
value = instance._values[self.name][instance.id]
if instance.id in instance._values_to_write[self.name]:
value = instance._values_to_write[self.name][instance.id]
return value
def __set__(self, instance, value):
if value is None:
value = False
value = self.check_value(value)
instance._values_to_write[self.name][instance.id] = value
super(Binary, self).__set__(instance, value)
class Boolean(BaseField):
"""Equivalent of the `fields.Boolean` class."""
def __init__(self, name, data):
super(Boolean, self).__init__(name, data)
def __get__(self, instance, owner):
value = instance._values[self.name][instance.id]
if instance.id in instance._values_to_write[self.name]:
value = instance._values_to_write[self.name][instance.id]
return value
def __set__(self, instance, value):
value = bool(value)
value = self.check_value(value)
instance._values_to_write[self.name][instance.id] = value
super(Boolean, self).__set__(instance, value)
class Char(BaseField):
"""Equivalent of the `fields.Char` class."""
def __init__(self, name, data):
super(Char, self).__init__(name, data)
def __get__(self, instance, owner):
value = instance._values[self.name].get(instance.id)
if instance.id in instance._values_to_write[self.name]:
value = instance._values_to_write[self.name][instance.id]
return value
def __set__(self, instance, value):
if value is None:
value = False
value = self.check_value(value)
instance._values_to_write[self.name][instance.id] = value
super(Char, self).__set__(instance, value)
class Date(BaseField):
"""Represent the OpenObject 'fields.data'"""
pattern = "%Y-%m-%d"
def __init__(self, name, data):
super(Date, self).__init__(name, data)
def __get__(self, instance, owner):
value = instance._values[self.name].get(instance.id) or False
if instance.id in instance._values_to_write[self.name]:
value = instance._values_to_write[self.name][instance.id]
try:
res = datetime.datetime.strptime(value, self.pattern).date()
except (ValueError, TypeError):
res = value
return res
def __set__(self, instance, value):
value = self.check_value(value)
instance._values_to_write[self.name][instance.id] = value
super(Date, self).__set__(instance, value)
def check_value(self, value):
super(Date, self).check_value(value)
if isinstance(value, datetime.date):
value = value.strftime("%Y-%m-%d")
elif is_string(value):
try:
datetime.datetime.strptime(value, self.pattern)
except:
raise ValueError(
"String not well formatted, expecting '{0}' format".format(
self.pattern))
elif isinstance(value, bool) or value is None:
return value
else:
raise ValueError(
"Expecting a datetime.date object or string")
return value
class Datetime(BaseField):
"""Represent the OpenObject 'fields.datetime'"""
pattern = "%Y-%m-%d %H:%M:%S"
def __init__(self, name, data):
super(Datetime, self).__init__(name, data)
def __get__(self, instance, owner):
value = instance._values[self.name].get(instance.id)
if instance.id in instance._values_to_write[self.name]:
value = instance._values_to_write[self.name][instance.id]
try:
res = datetime.datetime.strptime(value, self.pattern)
except (ValueError, TypeError):
res = value
return res
def __set__(self, instance, value):
value = self.check_value(value)
instance._values_to_write[self.name][instance.id] = value
super(Datetime, self).__set__(instance, value)
def check_value(self, value):
super(Datetime, self).check_value(value)
if isinstance(value, datetime.datetime):
value = value.strftime("%Y-%m-%d %H:%M:%S")
elif is_string(value):
try:
datetime.datetime.strptime(value, self.pattern)
except:
raise ValueError(
"Value not well formatted, expecting '{0}' format".format(
self.pattern))
elif isinstance(value, bool):
return value
else:
raise ValueError(
"Expecting a datetime.datetime object or string")
return value
class Float(BaseField):
"""Equivalent of the `fields.Float` class."""
def __init__(self, name, data):
super(Float, self).__init__(name, data)
def __get__(self, instance, owner):
value = instance._values[self.name].get(instance.id)
if instance.id in instance._values_to_write[self.name]:
value = instance._values_to_write[self.name][instance.id]
if value in [None, False]:
value = 0.0
return value
def __set__(self, instance, value):
if value is None:
value = False
value = self.check_value(value)
instance._values_to_write[self.name][instance.id] = value
super(Float, self).__set__(instance, value)
class Integer(BaseField):
"""Equivalent of the `fields.Integer` class."""
def __init__(self, name, data):
super(Integer, self).__init__(name, data)
def __get__(self, instance, owner):
value = instance._values[self.name].get(instance.id)
if instance.id in instance._values_to_write[self.name]:
value = instance._values_to_write[self.name][instance.id]
if value in [None, False]:
value = 0
return value
def __set__(self, instance, value):
if value is None:
value = False
value = self.check_value(value)
instance._values_to_write[self.name][instance.id] = value
super(Integer, self).__set__(instance, value)
class Selection(BaseField):
"""Represent the OpenObject 'fields.selection'"""
def __init__(self, name, data):
super(Selection, self).__init__(name, data)
self.selection = 'selection' in data and data['selection'] or False
def __get__(self, instance, owner):
value = instance._values[self.name].get(instance.id, False)
if instance.id in instance._values_to_write[self.name]:
value = instance._values_to_write[self.name][instance.id]
return value
def __set__(self, instance, value):
if value is None:
value = False
value = self.check_value(value)
instance._values_to_write[self.name][instance.id] = value
super(Selection, self).__set__(instance, value)
def check_value(self, value):
super(Selection, self).check_value(value)
selection = [val[0] for val in self.selection]
if value and value not in selection:
raise ValueError(
"The value '{0}' supplied doesn't match with the possible "
"values '{1}' for the '{2}' field".format(
value, selection, self.name,
))
return value
class Many2many(BaseField):
"""Represent the OpenObject 'fields.many2many'"""
def __init__(self, name, data):
super(Many2many, self).__init__(name, data)
self.relation = 'relation' in data and data['relation'] or False
self.context = 'context' in data and data['context'] or {}
self.domain = 'domain' in data and data['domain'] or False
def __get__(self, instance, owner):
"""Return a recordset."""
ids = None
if instance._values[self.name].get(instance.id):
ids = instance._values[self.name][instance.id][:]
# None value => get the value on the fly
if ids is None:
args = [[instance.id], [self.name]]
kwargs = {'context': self.context, 'load': '_classic_write'}
orig_ids = instance._odoo.execute_kw(
instance._name, 'read', args, kwargs)[0][self.name]
instance._values[self.name][instance.id] = orig_ids
ids = orig_ids and orig_ids[:] or []
# Take updated values into account
if instance.id in instance._values_to_write[self.name]:
values = instance._values_to_write[self.name][instance.id]
# Handle ODOO tuples to update 'ids'
ids = tuples2ids(values, ids or [])
# Handle the field context
Relation = instance.env[self.relation]
env = instance.env
if self.context:
context = instance.env.context.copy()
context.update(self.context)
env = instance.env(context=context)
return Relation._browse(
env, ids, from_record=(instance, self))
def __set__(self, instance, value):
value = self.check_value(value)
if isinstance(value, IncrementalRecords):
value = value.tuples
else:
if value and not odoo_tuple_in(value):
value = [(6, 0, records2ids(value))]
elif not value:
value = [(5, )]
instance._values_to_write[self.name][instance.id] = value
super(Many2many, self).__set__(instance, value)
def check_value(self, value):
if value:
if not isinstance(value, list) \
and not isinstance(value, Model) \
and not isinstance(value, IncrementalRecords):
raise ValueError(
"The value supplied has to be a list, a recordset "
"or 'False'")
return super(Many2many, self).check_value(value)
def store(self, record, value):
"""Store the value in the record."""
if record._values[self.name].get(record.id):
tuples2ids(value, record._values[self.name][record.id])
else:
record._values[self.name][record.id] = tuples2ids(value, [])
class Many2one(BaseField):
"""Represent the OpenObject 'fields.many2one'"""
def __init__(self, name, data):
super(Many2one, self).__init__(name, data)
self.relation = 'relation' in data and data['relation'] or False
self.context = 'context' in data and data['context'] or {}
self.domain = 'domain' in data and data['domain'] or False
def __get__(self, instance, owner):
id_ = instance._values[self.name].get(instance.id)
if instance.id in instance._values_to_write[self.name]:
id_ = instance._values_to_write[self.name][instance.id]
# None value => get the value on the fly
if id_ is None:
args = [[instance.id], [self.name]]
kwargs = {'context': self.context, 'load': '_classic_write'}
id_ = instance._odoo.execute_kw(
instance._name, 'read', args, kwargs)[0][self.name]
instance._values[self.name][instance.id] = id_
Relation = instance.env[self.relation]
if id_:
env = instance.env
if self.context:
context = instance.env.context.copy()
context.update(self.context)
env = instance.env(context=context)
return Relation._browse(
env, id_, from_record=(instance, self))
return Relation.browse(False)
def __set__(self, instance, value):
if isinstance(value, Model):
o_rel = value
elif is_int(value):
rel_obj = instance.env[self.relation]
o_rel = rel_obj.browse(value)
elif value in [None, False]:
o_rel = False
else:
raise ValueError("Value supplied has to be an integer, "
"a record object or 'None/False'.")
o_rel = self.check_value(o_rel)
#instance.__data__['updated_values'][self.name] = \
# o_rel and [o_rel.id, False]
instance._values_to_write[self.name][instance.id] = \
o_rel and o_rel.id or False
super(Many2one, self).__set__(instance, value)
def check_value(self, value):
super(Many2one, self).check_value(value)
if value and value._name != self.relation:
raise ValueError(
("Instance of '{model}' supplied doesn't match with the " +
"relation '{relation}' of the '{field_name}' field.").format(
model=value._name,
relation=self.relation,
field_name=self.name))
return value
class One2many(BaseField):
"""Represent the OpenObject 'fields.one2many'"""
def __init__(self, name, data):
super(One2many, self).__init__(name, data)
self.relation = 'relation' in data and data['relation'] or False
self.context = 'context' in data and data['context'] or {}
self.domain = 'domain' in data and data['domain'] or False
def __get__(self, instance, owner):
"""Return a recordset."""
ids = None
if instance._values[self.name].get(instance.id):
ids = instance._values[self.name][instance.id][:]
# None value => get the value on the fly
if ids is None:
args = [[instance.id], [self.name]]
kwargs = {'context': self.context, 'load': '_classic_write'}
orig_ids = instance._odoo.execute_kw(
instance._name, 'read', args, kwargs)[0][self.name]
instance._values[self.name][instance.id] = orig_ids
ids = orig_ids and orig_ids[:] or []
# Take updated values into account
if instance.id in instance._values_to_write[self.name]:
values = instance._values_to_write[self.name][instance.id]
# Handle ODOO tuples to update 'ids'
ids = tuples2ids(values, ids or [])
Relation = instance.env[self.relation]
env = instance.env
if self.context:
context = instance.env.context.copy()
context.update(self.context)
env = instance.env(context=context)
return Relation._browse(
env, ids, from_record=(instance, self))
def __set__(self, instance, value):
value = self.check_value(value)
if isinstance(value, IncrementalRecords):
value = value.tuples
else:
if value and not odoo_tuple_in(value):
value = [(6, 0, records2ids(value))]
elif not value:
value = [(5, )]
instance._values_to_write[self.name][instance.id] = value
super(One2many, self).__set__(instance, value)
def check_value(self, value):
if value:
if not isinstance(value, list) \
and not isinstance(value, Model) \
and not isinstance(value, IncrementalRecords):
raise ValueError(
"The value supplied has to be a list, a recordset "
"or 'False'")
return super(One2many, self).check_value(value)
def store(self, record, value):
"""Store the value in the record."""
if record._values[self.name].get(record.id):
tuples2ids(value, record._values[self.name][record.id])
else:
record._values[self.name][record.id] = tuples2ids(value, [])
class Reference(BaseField):
"""Represent the OpenObject 'fields.reference'."""
def __init__(self, name, data):
super(Reference, self).__init__(name, data)
self.context = 'context' in data and data['context'] or {}
self.domain = 'domain' in data and data['domain'] or False
self.selection = 'selection' in data and data['selection'] or False
def __get__(self, instance, owner):
value = instance._values[self.name].get(instance.id) or False
if instance.id in instance._values_to_write[self.name]:
value = instance._values_to_write[self.name][instance.id]
# None value => get the value on the fly
if value is None:
args = [[instance.id], [self.name]]
kwargs = {'context': self.context, 'load': '_classic_write'}
value = instance._odoo.execute_kw(
instance._name, 'read', args, kwargs)[0][self.name]
instance._values_to_write[self.name][instance.id] = value
if value:
parts = value.rpartition(',')
relation, o_id = parts[0], parts[2]
relation = relation.strip()
o_id = int(o_id.strip())
if relation and o_id:
Relation = instance.env[relation]
env = instance.env
if self.context:
context = instance.env.context.copy()
context.update(self.context)
env = instance.env(context=context)
return Relation._browse(
env, o_id, from_record=(instance, self))
return False
def __set__(self, instance, value):
value = self.check_value(value)
instance._values_to_write[self.name][instance.id] = value
super(Reference, self).__set__(instance, value)
def _check_relation(self, relation):
"""Raise a `ValueError` if `relation` is not allowed among
the possible values.
"""
selection = [val[0] for val in self.selection]
if relation not in selection:
raise ValueError(
("The value '{value}' supplied doesn't match with the possible"
" values '{selection}' for the '{field_name}' field").format(
value=relation,
selection=selection,
field_name=self.name,
))
return relation
def check_value(self, value):
if isinstance(value, Model):
relation = value.__class__.__osv__['name']
self._check_relation(relation)
value = "%s,%s" % (relation, value.id)
super(Reference, self).check_value(value)
elif is_string(value):
super(Reference, self).check_value(value)
parts = value.rpartition(',')
relation, o_id = parts[0], parts[2]
relation = relation.strip()
o_id = o_id.strip()
#o_rel = instance.__class__.__odoo__.browse(relation, o_id)
if not relation or not is_int(o_id):
raise ValueError("String not well formatted, expecting "
"'{relation},{id}' format")
self._check_relation(relation)
else:
raise ValueError("Value supplied has to be a string or"
" a browse_record object.")
return value
class Text(BaseField):
"""Equivalent of the `fields.Text` class."""
def __init__(self, name, data):
super(Text, self).__init__(name, data)
def __get__(self, instance, owner):
value = instance._values[self.name].get(instance.id)
if instance.id in instance._values_to_write[self.name]:
value = instance._values_to_write[self.name][instance.id]
return value
def __set__(self, instance, value):
if value is None:
value = False
value = self.check_value(value)
instance._values_to_write[self.name][instance.id] = value
super(Text, self).__set__(instance, value)
class Html(Text):
"""Equivalent of the `fields.Html` class."""
def __init__(self, name, data):
super(Html, self).__init__(name, data)
class Unknown(BaseField):
"""Represent an unknown field. This should not happen but this kind of
field only exists to avoid a blocking situation from a RPC point of view.
"""
def __init__(self, name, data):
super(Unknown, self).__init__(name, data)
def __get__(self, instance, owner):
value = instance._values[self.name][instance.id]
if instance.id in instance._values_to_write[self.name]:
value = instance._values_to_write[self.name][instance.id]
return value
def __set__(self, instance, value):
value = self.check_value(value)
instance._values_to_write[self.name][instance.id] = value
super(Unknown, self).__set__(instance, value)
TYPES_TO_FIELDS = {
'binary': Binary,
'boolean': Boolean,
'char': Char,
'date': Date,
'datetime': Datetime,
'float': Float,
'html': Html,
'integer': Integer,
'many2many': Many2many,
'many2one': Many2one,
'one2many': One2many,
'reference': Reference,
'selection': Selection,
'text': Text,
}
def generate_field(name, data):
"""Generate a well-typed field according to the data dictionary supplied
(obtained via the `fields_get' method of any models).
"""
assert 'type' in data
field = TYPES_TO_FIELDS.get(data['type'], Unknown)(name, data)
return field
# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
|