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
|
# coding: utf-8
# /*##########################################################################
#
# Copyright (c) 2016-2017 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ###########################################################################*/
__authors__ = ["H. Payno"]
__license__ = "MIT"
__date__ = "29/01/2021"
import logging
from .manager import ProcessManager
from .manager import DatasetState
from .dataset import Dataset
_logger = logging.getLogger(__name__)
class SuperviseProcess:
"""
Supervise process are processes with a state.
They are decoupled of BaseProcess because a SuperviseProcess can be
a group of BaseProcess. This is more dedicated to users.
For example Axis is a Base process that could only 'Suceed' or 'Failed'
But the SuperviseProcess Axis contained a stack. So it can also be
skipped, Pending or on going for example.
Still for Axis we will have in fact three actors:
- AxisProcess (tomwer.core.process.reconstruction.axis):
core source code for doing the center of rotation calculation
- AxisProcessStack (tomwer.synctools.stacks.reconstruction.axis):
stack to handle several call to axis
- _ProcessingThread (tomwer.synctools.stacks.reconstruction.axis):
set up and call AxisProcess from a thread
All those process will be grouped under the same SuperviseProcess
(sharing the same id) and all will be able to notify advancement
regarding this process.
:param Union[str,None] name: Supervise process name
:param int or None process_id: several Process can be 'group together'
If this is the case then the "master"
process should provide other the
process_id
if value is -1 then no supervision
should be provided.
"""
def __init__(self, name=None, process_id=None):
self._name = name
self._is_master_process = process_id is None
"""is this process the master process of the SuperviseProcess. Or is
it just one of the underlying process of a master SuperviseProcess"""
if process_id is None:
ProcessManager().register(self)
else:
self._set_process_id(process_id)
def __del__(self):
ProcessManager().unregister(self)
@property
def is_master_process(self):
return self._is_master_process
@property
def process_id(self):
return self.__process_id
def _set_process_id(self, process_id: int):
self.__process_id = process_id
@property
def name(self):
return self._name
@name.setter
def name(self, name):
if name != self._name:
old_name = self._name
self._name = name
def set_dataset_state(
self, dataset: Dataset, state: DatasetState, details=None
) -> None:
"""
Notify the supervisor that the state of this dataset has changed.
:param Dataset dataset: dataset with new state
:param DatasetState state:
:param Union[str,None] details: details regarding this process / dataset
"""
ProcessManager().notify_dataset_state(
dataset=dataset, process=self, state=state, details=details
)
def notify_to_state_to_managed(self, dataset, state, details) -> None:
"""
Notify the ProcessManager that a state of a specific dataset has changed.
:param dataset: dataset modified
:param state: new state of the dataset regarding this SuperviseProcess
:param details: details regarding the state (reasons, extra
informations...)
"""
ProcessManager().notify_dataset_state(
dataset=dataset, state=state, process=self, details=details
)
def reprocess(self, dataset):
"""
Reprocess a dataset.
:param Dataset dataset: dataset to reprocess
"""
_logger.warning(f"reprocess haven't been implemented yet for {self.name}")
def cancel(self, dataset=None):
"""
cancel (abort) processing of given dataset. If dataset is empty then conside this is the current processing that must be cancelled
"""
_logger.warning(
f"process cancellation haven't been implemented yet for {self.name}"
)
|
