Registry¶
Bases: NestedDict
Registry
for components.
Registry provides 3 core functionalities:
- Register a new component.
- Lookup for a component.
- Build a component.
To facilitate the usage scenario, registry
is designed to be a decorator.
You could register a component by simply calling registry.register
, and it will be registered with its name.
You may also specify the name of the component by calling registry.register(name="ComponentName")
.
build
makes it easy to construct a component from a configuration.
build
automatically determines the component to construct by the name
field in the configuration.
So you could either call registry.build(config)
or registry.build(**config)
.
Beyond this, build
is just a syntax sugar for registry.init(registry.lookup(name), *args, **kwargs)
.
lookup
is used to lookup for a component by its name.
By default, lookup
internally calls NestedDict.get
, but you may override it to provide more functionalities.
init
is used to construct a component.
By default, init
internally calls cls(*args, **kwargs)
, but you may override it to provide more functionalities.
Notes
Registry
inherits from NestedDict
.
Therefore, Registry
comes in a nested structure by nature.
You could create a sub-registry by simply calling registry.sub_registry = Registry
,
and access through registry.sub_registry.register()
.
Examples:
>>> registry = Registry()
>>> @registry.register
... @registry.register("Module1")
... class Module:
... def __init__(self, a, b):
... self.a = a
... self.b = b
>>> module = registry.register(Module, "Module2")
>>> registry
Registry(
('Module1'): <class 'chanfig.registry.Module'>
('Module'): <class 'chanfig.registry.Module'>
('Module2'): <class 'chanfig.registry.Module'>
)
>>> module = registry.register(Module, "Module")
Traceback (most recent call last):
ValueError: Component with name Module already registered.
>>> registry.lookup("Module")
<class 'chanfig.registry.Module'>
>>> config = {"module": {"name": "Module", "a": 1, "b": 2}}
>>> # registry.register(Module)
>>> module = registry.build(config["module"])
>>> type(module)
<class 'chanfig.registry.Module'>
>>> module.a
1
>>> module.b
2
Source code in chanfig/registry.py
Python | |
---|---|
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 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
|
build(name, *args, **kwargs)
¶
Build a component.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str | Mapping
|
If its a |
required |
*args |
Any
|
The arguments to pass to the component. |
()
|
**kwargs |
Any
|
The keyword arguments to pass to the component. |
{}
|
Returns:
Type | Description |
---|---|
Any
|
|
Raises:
Type | Description |
---|---|
KeyError
|
If the component is not registered. |
Examples:
>>> registry = Registry()
>>> @registry.register
... class Module:
... def __init__(self, a, b):
... self.a = a
... self.b = b
>>> config = {"module": {"name": "Module", "a": 1, "b": 2}}
>>> # registry.register(Module)
>>> module = registry.build(**config["module"])
>>> type(module)
<class 'chanfig.registry.Module'>
>>> module.a
1
>>> module.b
2
>>> module = registry.build(config["module"], a=2)
>>> module.a
2
Source code in chanfig/registry.py
init(*args, **kwargs)
staticmethod
¶
Constructor of component.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cls |
Callable
|
The component to construct. |
required |
*args |
Any
|
The arguments to pass to the component. |
()
|
**kwargs |
Any
|
The keyword arguments to pass to the component. |
{}
|
Returns:
Type | Description |
---|---|
Any
|
|
Examples:
>>> class Module:
... def __init__(self, a, b):
... self.a = a
... self.b = b
>>> kwargs = {"a": 1, "b": 2}
>>> module = Registry.init(Module, **kwargs)
>>> type(module)
<class 'chanfig.registry.Module'>
>>> module.a
1
>>> module.b
2
Source code in chanfig/registry.py
lookup(name)
¶
Lookup for a component.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
|
required |
Returns:
Type | Description |
---|---|
Any
|
The component. |
Raises:
Type | Description |
---|---|
KeyError
|
If the component is not registered. |
Examples:
>>> registry = Registry()
>>> @registry.register
... class Module:
... def __init__(self, a, b):
... self.a = a
... self.b = b
>>> registry.lookup("Module")
<class 'chanfig.registry.Module'>
Source code in chanfig/registry.py
register(component=None, name=None, override=False)
¶
Register a new component.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
component |
Any
|
The component to register. |
None
|
name |
Any | None
|
The name of the component. |
None
|
Returns:
Name | Type | Description |
---|---|---|
component |
Callable
|
The registered component.
Registered component are expected to be |
Raises:
Type | Description |
---|---|
ValueError
|
If the component with the same name already registered and |
Examples:
>>> registry = Registry()
>>> @registry.register
... @registry.register("Module1")
... class Module:
... def __init__(self, a, b):
... self.a = a
... self.b = b
>>> module = registry.register(Module, "Module2")
>>> registry
Registry(
('Module1'): <class 'chanfig.registry.Module'>
('Module'): <class 'chanfig.registry.Module'>
('Module2'): <class 'chanfig.registry.Module'>
)