{"id":13,"date":"2023-07-27T11:40:00","date_gmt":"2023-07-27T11:40:00","guid":{"rendered":""},"modified":"2024-01-28T09:05:18","modified_gmt":"2024-01-28T09:05:18","slug":"method-and-decorator-in-odoo","status":"publish","type":"post","link":"https:\/\/pythonpower.in\/index.php\/2023\/07\/27\/method-and-decorator-in-odoo\/","title":{"rendered":"Method and decorator In Odoo"},"content":{"rendered":"<\/p>\n
<\/div>\n

 <\/p>\n

<\/a><\/div>\n
<\/div>\n
<\/div>\n
\n

Method and decorator<\/h1>\n

New decorators are just mapper around the new API. The decorator are mandatory as webclient and HTTP controller are not compliant with new API.<\/span><\/p>\n

api<\/span><\/code> namespace decorators will detect signature using variable name and decide to match old signature or not.<\/span><\/p>\n

Recognized variable names are:<\/span><\/p>\n

cr, cursor, uid, user, user_id, id, ids, context<\/span><\/code><\/p>\n

<\/a><\/span><\/span><\/p>\n

<\/svg><\/path><\/span><\/a>@api.returns<\/h2>\n

This decorator guaranties unity of returned value. It will return a RecordSet of specified model based on original returned value:<\/span><\/p>\n

@api.returns('res.partner')\ndef afun(self):\n    ...\n    return x  # a RecordSet<\/span>\n<\/span><\/span><\/pre>\n
And if an old API function calls a new API function it will automatically convert it into a list of ids<\/span><\/p>\n
All decorators inherits from this decorator to upgrade or downgrade the returned value.<\/span><\/p>\n
<\/a><\/span><\/span><\/p>\n
<\/svg><\/path><\/span><\/a>@api.one<\/h2>\n
T<\/span>his decorator loops automatically on Records of RecordSet for you. Self is redefined as current record:<\/span><\/p>\n
@api.one\ndef afun(self):\n    self.name = 'toto'<\/span>\n<\/span><\/span><\/pre>\n
\n
Note<\/span><\/p>\n
Caution: the returned value is put in a list. This is not always supported by the web client, e.g. on button action methods. In that case, you should use @api.multi<\/code> to decorate your method, and probably call self.ensure_one() in the method definition.<\/span><\/p>\n<\/div>\n
<\/a><\/span><\/span><\/p>\n
<\/svg><\/path><\/span><\/a>@api.multi<\/h2>\n
Self will be the current RecordSet without iteration. It is the default behavior:<\/span><\/p>\n
@api.multi\ndef afun(self):\n    len(self)<\/span>\n<\/span><\/pre>\n
<\/a><\/span><\/p>\n
<\/path><\/svg><\/a>@api.model<\/h2>\n
This decorator will convert old API calls to decorated function to new API signature. It allows to be polite when migrating code.<\/span><\/p>\n
@api.model\ndef afun(self):\n    pass<\/span>\n<\/span><\/pre>\n
<\/a><\/span><\/p>\n
<\/path><\/svg><\/a>@api.constrains<\/h2>\n
This decorator will ensure that decorated function will be called on create, write, unlink operation. If a constraint is met the function should raise a openerp.exceptions.Warning with appropriate messag<\/span>e.<\/span><\/p>\n
<\/a><\/span><\/p>\n
<\/path><\/svg><\/a>@api.depends<\/h2>\n
This decorator will trigger the call to the decorated function if any of the fields specified in the decorator is altered by ORM or changed in the form:<\/span><\/p>\n
@api.depends('name', 'an_other_field')\ndef afun(self):\n    pass<\/span>\n<\/span><\/span><\/pre>\n
\n
Note<\/span><\/p>\n
when you redefine depends you have to redefine all @api.depends, so it loses some of his interest.<\/span><\/p>\n<\/div>\n
<\/a><\/span><\/p>\n
<\/path><\/svg><\/a>View management<\/h3>\n
One of the great improvement of the new API is that the depends are automatically inserted into the form for you in a simple way. You do not have to worry about modifying views anymore.<\/span><\/p>\n
<\/a><\/span><\/p>\n
<\/path><\/svg><\/a>@api.onchange<\/h2>\n
This decorator will trigger the call to the decorated function if any of the fields specified in the decorator is changed in the form:<\/span><\/p>\n
@api.onchange('fieldx')\ndef do_stuff(self):\n   if self.fieldx == x:\n      self.fieldy = 'toto'\n<\/span><\/pre>\n
In previous sample self corresponds to the record currently edited on the form. When in on_change context all work is done in the cache. So you can alter RecordSet inside your function without being worried about altering database. That’s the main difference with @api.depends<\/code><\/span><\/p>\n
At function return, differences between the cache and the RecordSet will be returned to the form.<\/span><\/p>\n
<\/a><\/span><\/span><\/p>\n
<\/svg><\/path><\/span><\/a>View management<\/span><\/h3>\n
One of the great improvement of the new API is that the onchange are automatically inserted into the form for you in a simple way. You do not have to worry about modifying views anymore<\/span><\/p>\n<\/div>\n

<\/span><\/div>\n

<\/span><\/div>\n

<\/span><\/div>\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
  Method and decorator New decorators are just mapper around the new API. The decorator…<\/p>\n","protected":false},"author":2,"featured_media":70,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"om_disable_all_campaigns":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":"","_joinchat":[]},"categories":[5],"tags":[],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/pythonpower.in\/index.php\/wp-json\/wp\/v2\/posts\/13"}],"collection":[{"href":"https:\/\/pythonpower.in\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/pythonpower.in\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/pythonpower.in\/index.php\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/pythonpower.in\/index.php\/wp-json\/wp\/v2\/comments?post=13"}],"version-history":[{"count":1,"href":"https:\/\/pythonpower.in\/index.php\/wp-json\/wp\/v2\/posts\/13\/revisions"}],"predecessor-version":[{"id":71,"href":"https:\/\/pythonpower.in\/index.php\/wp-json\/wp\/v2\/posts\/13\/revisions\/71"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/pythonpower.in\/index.php\/wp-json\/wp\/v2\/media\/70"}],"wp:attachment":[{"href":"https:\/\/pythonpower.in\/index.php\/wp-json\/wp\/v2\/media?parent=13"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/pythonpower.in\/index.php\/wp-json\/wp\/v2\/categories?post=13"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/pythonpower.in\/index.php\/wp-json\/wp\/v2\/tags?post=13"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}