# -*- coding: utf-8 -*-
##############################################################################
#
# Author: Guewen Baconnier
# Copyright 2012-2013 Camptocamp SA
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
from collections import Callable
from .connector import get_openerp_module
[docs]class Event(object):
""" An event contains consumers called when the event is fired.
The events are able to filter the consumers to execute by model name.
The usage of an event is to instantiate an `Event` object::
on_my_event = Event()
An event always have at least the 2 following arguments:
* session
* model_name
Then to subscribe one or more consumers, an event has a function::
def do_something(session, model_name, a, b):
print "Event was fired with arguments: %s, %s" % (a, b)
# active on all models
on_my_event.subscribe(do_something)
def do_something_product(session, model_name, a, b):
print ("Event was fired on a product "
"with arguments: %s, %s" % (a, b))
# active only on product.product
on_my_event.subscribe(do_something_product,
model_names='product.product')
We can also replace a consumer::
def do_something_product2(session, model_name, a, b):
print "Consumer 2"
print ("Event was fired on a product "
"with arguments: %s, %s" % (a, b))
on_my_event.subscribe(do_something_product2,
replacing=do_something_product)
Finally, we fire the event::
on_my_event.fire(session, 'res.users', 'value_a', 'value_b')
A consumer can be subscribed using a decorator::
@on_my_event
def do_other_thing(session, model_name, a, b):
print 'foo'
@on_my_event(replacing=do_other_thing)
def print_bar(session, model_name, a, b):
print 'bar'
"""
def __init__(self):
self._consumers = {None: set()}
[docs] def subscribe(self, consumer, model_names=None, replacing=None):
""" Subscribe a consumer on the event
:param consumer: the function to register on the event
:param model_names: the consumer will be active only on these models,
active on all models if ``None``
:param replacing: the function beeing replaced by this new one.
"""
if replacing is not None:
self.unsubscribe(replacing, model_names=model_names)
if not hasattr(model_names, '__iter__'):
model_names = [model_names]
for name in model_names:
self._consumers.setdefault(name, set()).add(consumer)
[docs] def unsubscribe(self, consumer, model_names=None):
""" Remove a consumer from the event
:param consumer: the function to unsubscribe
:param model_names: remove only for these models or remove a
consumer which is active on all models if ``None``.
"""
if not hasattr(model_names, '__iter__'):
model_names = [model_names]
for name in model_names:
if name in self._consumers:
self._consumers[name].discard(consumer)
[docs] def has_consumer_for(self, session, model_name):
""" Return True if at least one consumer is registered
for the model.
"""
if any(self._consumers_for(session, None)):
return True # at least 1 global consumer exist
return any(self._consumers_for(session, model_name))
def _consumers_for(self, session, model_name):
is_installed = session.is_module_installed
return (cons for cons in self._consumers.get(model_name, ())
if is_installed(get_openerp_module(cons)))
[docs] def fire(self, session, model_name, *args, **kwargs):
""" Call each consumer subscribed on the event with the given
arguments and keyword arguments.
All the consumers which were subscribed globally (no model name) or
which are subscribed on the same model
:param session: current session
:type session: :py:class:`connector.session.Session`
:param model_name: name of the model
:type model_name: str
:param args: arguments propagated to the consumer
The second argument of `args` is the model name.
The first argument is the session.
:param kwargs: keyword arguments propagated to the consumer
"""
assert isinstance(model_name, basestring), (
"Second argument must be the model name as string, "
"instead received: %s" % model_name)
args = tuple([session, model_name] + list(args))
for name in (None, model_name):
for consumer in self._consumers_for(session, name):
consumer(*args, **kwargs)
def __call__(self, *args, **kwargs):
""" Event decorator
For an event ``on_event`` declared like this::
on_event = Event()
A consumer can be subscribed using::
@on_event
def do_things(arg1, arg2):
# work
And for consumers specific to models::
@on_event(model_names=['product.product', 'res.partner'])
def do_things(arg1, arg2):
# work
The accepted arguments are those of :meth:`subscribe`.
"""
def with_subscribe(**opts):
def wrapped_func(func):
self.subscribe(func, **opts)
return func
return wrapped_func
if len(args) == 1 and isinstance(args[0], Callable):
return with_subscribe(**kwargs)(*args)
return with_subscribe(**kwargs)
on_record_write = Event()
"""
``on_record_write`` is fired when one record has been updated.
Listeners should take the following arguments:
* session: :py:class:`~connector.session.ConnectorSession` object
* model_name: name of the model
* record_id: id of the record
* vals: field values of the new record, e.g {'field_name': field_value, ...}
"""
on_record_create = Event()
"""
``on_record_create`` is fired when one record has been created.
Listeners should take the following arguments:
* session: :py:class:`~connector.session.ConnectorSession` object
* model_name: name of the model
* record_id: id of the created record
* vals: field values updated, e.g {'field_name': field_value, ...}
"""
on_record_unlink = Event()
"""
``on_record_unlink`` is fired when one record has been deleted.
Listeners should take the following arguments:
* session: :py:class:`~connector.session.ConnectorSession` object
* model_name: name of the model
* record_id: id of the record
"""