Debian Codegraph @

pymeasure/process.py

raw
1 #
2 # This file is part of the PyMeasure package.
3 #
4 # Copyright (c) 2013-2024 PyMeasure Developers
5 #
6 # Permission is hereby granted, free of charge, to any person obtaining a copy
7 # of this software and associated documentation files (the "Software"), to deal
8 # in the Software without restriction, including without limitation the rights
9 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 # copies of the Software, and to permit persons to whom the Software is
11 # furnished to do so, subject to the following conditions:
12 #
13 # The above copyright notice and this permission notice shall be included in
14 # all copies or substantial portions of the Software.
15 #
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 # THE SOFTWARE.
23 #
24
25 import logging
26
27 from multiprocessing import get_context
28
29 log = logging.getLogger(__name__)
30 log.addHandler(logging.NullHandler())
31
32 context = get_context()
33 # Useful for multiprocessing debugging:
34 # context.log_to_stderr(logging.DEBUG)
35
36
37 class StoppableProcess(context.Process):
38 """ Base class for Processes which require the ability
39 to be stopped by a process-safe method call
40 """
41
42 def __init__(self):
43 super().__init__()
44 self._should_stop = context.Event()
45 self._should_stop.clear()
46
47 def join(self, timeout=0):
48 """ Joins the current process and forces it to stop after
49 the timeout if necessary
50
51 :param timeout: Timeout duration in seconds
52 """
53 self._should_stop.wait(timeout)
54 if not self.should_stop():
55 self.stop()
56 return super().join(0)
57
58 def stop(self):
59 self._should_stop.set()
60
61 def should_stop(self):
62 return self._should_stop.is_set()
63
64 def __repr__(self):
65 return "<{}(should_stop={})>".format(
66 self.__class__.__name__, self.should_stop())