|
| 1 | +# Copyright (c) MONAI Consortium |
| 2 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 3 | +# you may not use this file except in compliance with the License. |
| 4 | +# You may obtain a copy of the License at |
| 5 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 6 | +# Unless required by applicable law or agreed to in writing, software |
| 7 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 8 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 9 | +# See the License for the specific language governing permissions and |
| 10 | +# limitations under the License. |
| 11 | + |
| 12 | +from __future__ import annotations |
| 13 | + |
| 14 | +from collections import namedtuple |
| 15 | +from keyword import iskeyword |
| 16 | +from textwrap import dedent, indent |
| 17 | +from typing import Any, Callable, Iterable, TypeVar |
| 18 | + |
| 19 | +T = TypeVar("T") |
| 20 | +from monai.utils.factory import Factory |
| 21 | + |
| 22 | + |
| 23 | +def is_variable(name): |
| 24 | + """Returns True if `name` is a valid Python variable name and also not a keyword.""" |
| 25 | + return name.isidentifier() and not iskeyword(name) |
| 26 | + |
| 27 | + |
| 28 | +class ComponentStore(Factory): |
| 29 | + """ |
| 30 | + Represents a storage object for other objects (specifically functions) keyed to a name with a description. |
| 31 | +
|
| 32 | + These objects act as global named places for storing components for objects parameterised by component names. |
| 33 | + Typically this is functions although other objects can be added. Printing a component store will produce a |
| 34 | + list of members along with their docstring information if present. |
| 35 | +
|
| 36 | + Example: |
| 37 | +
|
| 38 | + .. code-block:: python |
| 39 | +
|
| 40 | + TestStore = ComponentStore("Test Store", "A test store for demo purposes") |
| 41 | +
|
| 42 | + @TestStore.add_def("my_func_name", "Some description of your function") |
| 43 | + def _my_func(a, b): |
| 44 | + '''A description of your function here.''' |
| 45 | + return a * b |
| 46 | +
|
| 47 | + print(TestStore) # will print out name, description, and 'my_func_name' with the docstring |
| 48 | +
|
| 49 | + func = TestStore["my_func_name"] |
| 50 | + result = func(7, 6) |
| 51 | +
|
| 52 | + """ |
| 53 | + |
| 54 | + _Component = namedtuple("Component", ("description", "value")) # internal value pair |
| 55 | + |
| 56 | + def __init__(self, name: str, description: str) -> None: |
| 57 | + self.components: dict[str, self._Component] = {} |
| 58 | + self.name: str = name |
| 59 | + self.description: str = description |
| 60 | + |
| 61 | + self.__doc__ = f"Component Store '{name}': {description}\n{self.__doc__ or ''}".strip() |
| 62 | + |
| 63 | + def add(self, name: str, desc: str, value: T) -> T: |
| 64 | + """Store the object `value` under the name `name` with description `desc`.""" |
| 65 | + if not is_variable(name): |
| 66 | + raise ValueError("Name of component must be valid Python identifier") |
| 67 | + |
| 68 | + self.components[name] = self._Component(desc, value) |
| 69 | + return value |
| 70 | + |
| 71 | + def add_def(self, name: str, desc: str) -> Callable: |
| 72 | + """Returns a decorator which stores the decorated function under `name` with description `desc`.""" |
| 73 | + |
| 74 | + def deco(func): |
| 75 | + """Decorator to add a function to a store.""" |
| 76 | + return self.add(name, desc, func) |
| 77 | + |
| 78 | + return deco |
| 79 | + |
| 80 | + def __contains__(self, name: str) -> bool: |
| 81 | + """Returns True if the given name is stored.""" |
| 82 | + return name in self.components |
| 83 | + |
| 84 | + def __len__(self) -> int: |
| 85 | + """Returns the number of stored components.""" |
| 86 | + return len(self.components) |
| 87 | + |
| 88 | + def __iter__(self) -> Iterable: |
| 89 | + """Yields name/component pairs.""" |
| 90 | + for k, v in self.components.items(): |
| 91 | + yield k, v.value |
| 92 | + |
| 93 | + def __str__(self): |
| 94 | + result = f"Component Store '{self.name}': {self.description}\nAvailable components:" |
| 95 | + for k, v in self.components.items(): |
| 96 | + result += f"\n* {k}:" |
| 97 | + |
| 98 | + if hasattr(v.value, "__doc__"): |
| 99 | + doc = indent(dedent(v.value.__doc__.lstrip("\n").rstrip()), " ") |
| 100 | + result += f"\n{doc}\n" |
| 101 | + else: |
| 102 | + result += f" {v.description}" |
| 103 | + |
| 104 | + return result |
| 105 | + |
| 106 | + def __getattr__(self, name: str) -> Any: |
| 107 | + """Returns the stored object under the given name.""" |
| 108 | + if name in self.components: |
| 109 | + return self.components[name].value |
| 110 | + else: |
| 111 | + return self.__getattribute__(name) |
| 112 | + |
| 113 | + def __getitem__(self, name: str) -> Any: |
| 114 | + """Returns the stored object under the given name.""" |
| 115 | + if name in self.components: |
| 116 | + return self.components[name].value |
| 117 | + else: |
| 118 | + raise ValueError(f"Component '{name}' not found") |
0 commit comments