Mercurial > libervia-backend

comparison libervia/backend/tools/async_trigger.py @ 4071:4b842c1fb686

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
refactoring: renamed `sat` package to `libervia.backend`
author Goffi <goffi@goffi.org>
date Fri, 02 Jun 2023 11:49:51 +0200
parents sat/tools/async_trigger.py@524856bd7b19
children e11b13418ba6
comparison
equal deleted inserted replaced
4070:d10748475025 4071:4b842c1fb686
1 #!/usr/bin/env python3
2
3
4 # SAT: a jabber client
5 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
6
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
11
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
16
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
19
20 """Misc usefull classes"""
21
22 from typing import Tuple, Any
23 from . import trigger as sync_trigger
24 from . import utils
25 from twisted.internet import defer
26
27 class TriggerManager(sync_trigger.TriggerManager):
28 """This is a TriggerManager with an new async_point method"""
29
30 @defer.inlineCallbacks
31 def async_point(self, point_name, *args, **kwargs):
32 """This put a trigger point with potentially async Deferred
33
34 All the triggers for that point will be run
35 @param point_name: name of the trigger point
36 @param *args: args to transmit to trigger
37 @param *kwargs: kwargs to transmit to trigger
38 if "triggers_no_cancel" is present, it will be popped out
39 when set to True, this argument don't let triggers stop
40 the workflow
41 @return D(bool): True if the action must be continued, False else
42 """
43 if point_name not in self.__triggers:
44 defer.returnValue(True)
45
46 can_cancel = not kwargs.pop('triggers_no_cancel', False)
47
48 for priority, trigger in self.__triggers[point_name]:
49 try:
50 cont = yield utils.as_deferred(trigger, *args, **kwargs)
51 if can_cancel and not cont:
52 defer.returnValue(False)
53 except sync_trigger.SkipOtherTriggers:
54 break
55 defer.returnValue(True)
56
57 async def async_return_point(
58 self,
59 point_name: str,
60 *args, **kwargs
61 ) -> Tuple[bool, Any]:
62 """Async version of return_point"""
63 if point_name not in self.__triggers:
64 return True, None
65
66 for priority, trigger in self.__triggers[point_name]:
67 try:
68 cont, ret_value = await utils.as_deferred(trigger, *args, **kwargs)
69 if not cont:
70 return False, ret_value
71 except sync_trigger.SkipOtherTriggers:
72 break
73 return True, None
74