# registry

Python API: `luxonis_ml.utils.registry`

## 类

### AutoRegisterMeta

用于自动注册模块的元类。

可以设置为抽象基类的元类。该类的所有子类都将自动注册。

> **示例**
> ```pycon
>>> REGISTRY = Registry(name="modules")
>>> class Base(
...     metaclass=AutoRegisterMeta,
...     registry=REGISTRY,
...     register=False,
... ):
...     pass
>>> class Foo(Base):
...     pass
>>> class Bar(Base, register_name="Baz"):
...     pass
>>> REGISTRY.get("Foo").__name__
'Foo'
>>> Base.REGISTRY.get("Baz").__name__
'Bar'
```

#### 属性

##### REGISTRY

在基类上定义的内部注册表。

### Registry

用于存储和检索模块的注册表。

注册表存储从字符串键到模块类的映射。它提供了一个接口来注册模块，然后通过它们的字符串名称检索它们。

#### 方法

##### init

```python
def __init__(name: str):
```

创建一个新的空注册表。

参数

 * `name` (`str`): 注册表的名称，用于错误消息。

##### get

```python
def get(key: str) -> T:
```

检索键的注册表记录。

参数

 * `key` (`str`): 注册项的名称。

返回

 * `T`: 对应于键的注册项。

抛出

 * `KeyError`: 如果在注册表中找不到键。

##### register

```python
def register(module: T | None = None, *, name: str | None = None, force: bool = False) -> Callable[[T], T] | None:
```

注册一个模块。

可以用作装饰器或普通方法：

> **示例**
> ```pycon
>>> registry = Registry(name="modules")
>>> @registry.register()
... class Foo:
...     pass
>>> registry.get("Foo").__name__
'Foo'
>>> class Bar:
...     pass
>>> registry.register(module=Bar)
>>> registry.get("Bar").__name__
'Bar'
```

参数

 * `module` (`T | None`): 要注册的模块类。
 * `name` (`str | None`): 模块的名称。如果为 `None`，则使用类名。
 * `force` (`bool`): 是否覆盖同名现有类。

返回

 * `Callable[[T], T] | None`: 如果用作普通方法，则为 `None`；如果用作装饰器，则为装饰器函数。

抛出

 * `KeyError`: 如果已存在同名模块且 `force` 为 `False`。

##### register_module

```python
def register_module(name: str | None = None, module: T | None = None, force: bool = False) -> T | Callable[[T], T]:
```

注册一个模块。已弃用，请改用
[register](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/registry.md)。

> **已弃用**
> 自 0.6.0 版本起已弃用：请改用 [register](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/registry.md)。

参数

 * `name` (`str | None`): 模块的名称。如果为 `None`，则使用类名。
 * `module` (`T | None`): 要注册的模块类。
 * `force` (`bool`): 是否覆盖同名现有类。

返回

 * `T | Callable[[T], T]`: 注册的模块或
   [register](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/registry.md)
   返回的装饰器。

抛出

 * `KeyError`: 如果已存在同名模块且 `force` 为 `False`。

#### 属性

##### name

注册表的名称。

## 属性

### T
