# {py:mod}`ros_sugar.robot.registries`

```{py:module} ros_sugar.robot.registries
```

```{autodoc2-docstring} ros_sugar.robot.registries
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`ActionSpec <ros_sugar.robot.registries.ActionSpec>`
  - ```{autodoc2-docstring} ros_sugar.robot.registries.ActionSpec
    :summary:
    ```
* - {py:obj}`EventSpec <ros_sugar.robot.registries.EventSpec>`
  - ```{autodoc2-docstring} ros_sugar.robot.registries.EventSpec
    :summary:
    ```
* - {py:obj}`ActionRegistry <ros_sugar.robot.registries.ActionRegistry>`
  - ```{autodoc2-docstring} ros_sugar.robot.registries.ActionRegistry
    :summary:
    ```
* - {py:obj}`EventRegistry <ros_sugar.robot.registries.EventRegistry>`
  - ```{autodoc2-docstring} ros_sugar.robot.registries.EventRegistry
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`plugin_action <ros_sugar.robot.registries.plugin_action>`
  - ```{autodoc2-docstring} ros_sugar.robot.registries.plugin_action
    :summary:
    ```
````

### API

````{py:function} plugin_action(function: typing.Optional[typing.Callable] = None, description: typing.Optional[typing.Union[str, typing.Dict]] = None)
:canonical: ros_sugar.robot.registries.plugin_action

```{autodoc2-docstring} ros_sugar.robot.registries.plugin_action
```
````

````{py:class} ActionSpec
:canonical: ros_sugar.robot.registries.ActionSpec

Bases: {py:obj}`ros_sugar.config.BaseAttrs`

```{autodoc2-docstring} ros_sugar.robot.registries.ActionSpec
```

````

````{py:class} EventSpec
:canonical: ros_sugar.robot.registries.EventSpec

Bases: {py:obj}`ros_sugar.config.BaseAttrs`

```{autodoc2-docstring} ros_sugar.robot.registries.EventSpec
```

````

`````{py:class} ActionRegistry(factories: typing.Dict[str, typing.Callable[..., ros_sugar.core.action.Action]])
:canonical: ros_sugar.robot.registries.ActionRegistry

Bases: {py:obj}`ros_sugar.robot.registries._FactoryRegistry`

```{autodoc2-docstring} ros_sugar.robot.registries.ActionRegistry
```

````{py:method} list() -> typing.List[ros_sugar.robot.registries.ActionSpec]
:canonical: ros_sugar.robot.registries.ActionRegistry.list

```{autodoc2-docstring} ros_sugar.robot.registries.ActionRegistry.list
```

````

````{py:method} tool_descriptions(namespace: typing.Optional[str] = None) -> typing.List[typing.Dict[str, typing.Any]]
:canonical: ros_sugar.robot.registries.ActionRegistry.tool_descriptions

```{autodoc2-docstring} ros_sugar.robot.registries.ActionRegistry.tool_descriptions
```

````

````{py:method} tool_descriptions_json(namespace: typing.Optional[str] = None) -> str
:canonical: ros_sugar.robot.registries.ActionRegistry.tool_descriptions_json

```{autodoc2-docstring} ros_sugar.robot.registries.ActionRegistry.tool_descriptions_json
```

````

````{py:method} names() -> typing.List[str]
:canonical: ros_sugar.robot.registries.ActionRegistry.names

```{autodoc2-docstring} ros_sugar.robot.registries.ActionRegistry.names
```

````

`````

`````{py:class} EventRegistry(factories: typing.Dict[str, typing.Callable[..., ros_sugar.core.event.Event]])
:canonical: ros_sugar.robot.registries.EventRegistry

Bases: {py:obj}`ros_sugar.robot.registries._FactoryRegistry`

```{autodoc2-docstring} ros_sugar.robot.registries.EventRegistry
```

````{py:method} list() -> typing.List[ros_sugar.robot.registries.EventSpec]
:canonical: ros_sugar.robot.registries.EventRegistry.list

```{autodoc2-docstring} ros_sugar.robot.registries.EventRegistry.list
```

````

````{py:method} names() -> typing.List[str]
:canonical: ros_sugar.robot.registries.EventRegistry.names

```{autodoc2-docstring} ros_sugar.robot.registries.EventRegistry.names
```

````

`````