lsst.pipe.tasks gec3662e80e+8f8c708f41
_configurableAction.py
Go to the documentation of this file.
1# This file is part of pipe_tasks.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
21from __future__ import annotations
22
23__all__ = ["ConfigurableAction"]
24
25from typing import Any
26
27from lsst.pex.config.config import Config
28
29
31 """A `ConfigurableAction` is an interface that extends a
32 `lsst.pex.config.Config` class to include a `__call__` method.
33
34 This interface is designed to create an action that can be used at
35 runtime with state that is determined during the configuration stage. A
36 single action thus may be assigned multiple times, each with different
37 configurations.
38
39 This allows state to be set and recorded at configuration time,
40 making future reproduction of results easy.
41
42 This class is intended to be an interface only, but because of various
43 inheritance conflicts this class can not be implemented as an Abstract
44 Base Class. Instead, the `__call__` method is purely virtual, meaning that
45 it will raise a `NotImplementedError` when called. Subclasses that
46 represent concrete actions must provide an override.
47 """
48 def __call__(self, *args, **kwargs) -> Any:
49 raise NotImplementedError("This method should be overloaded in subclasses")