# {py:mod}`django_socio_grpc.grpc_actions.actions`

```{py:module} django_socio_grpc.grpc_actions.actions
```

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`GRPCAction <django_socio_grpc.grpc_actions.actions.GRPCAction>`
  - ```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction
    :summary:
    ```
* - {py:obj}`GRPCActionMixin <django_socio_grpc.grpc_actions.actions.GRPCActionMixin>`
  -
````

### Functions

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

* - {py:obj}`register_action <django_socio_grpc.grpc_actions.actions.register_action>`
  - ```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.register_action
    :summary:
    ```
````

### Data

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

* - {py:obj}`logger <django_socio_grpc.grpc_actions.actions.logger>`
  - ```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.logger
    :summary:
    ```
* - {py:obj}`RequestResponseType <django_socio_grpc.grpc_actions.actions.RequestResponseType>`
  - ```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.RequestResponseType
    :summary:
    ```
````

### API

````{py:data} logger
:canonical: django_socio_grpc.grpc_actions.actions.logger
:value: >
   'getLogger(...)'

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.logger
```

````

````{py:data} RequestResponseType
:canonical: django_socio_grpc.grpc_actions.actions.RequestResponseType
:value: >
   None

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.RequestResponseType
```

````

`````{py:class} GRPCAction
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction
```

````{py:attribute} function
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.function
:type: collections.abc.Callable[[django_socio_grpc.services.Service, typing.Any, django_socio_grpc.request_transformer.grpc_internal_proxy.GRPCInternalProxyContext], typing.Any]
:value: >
   None

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.function
```

````

````{py:attribute} request
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.request
:type: django_socio_grpc.grpc_actions.actions.RequestResponseType | None
:value: >
   None

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.request
```

````

````{py:attribute} response
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.response
:type: django_socio_grpc.grpc_actions.actions.RequestResponseType | None
:value: >
   None

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.response
```

````

````{py:attribute} request_name
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.request_name
:type: str | None
:value: >
   None

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.request_name
```

````

````{py:attribute} response_name
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.response_name
:type: str | None
:value: >
   None

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.response_name
```

````

````{py:attribute} request_stream
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.request_stream
:type: bool
:value: >
   False

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.request_stream
```

````

````{py:attribute} response_stream
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.response_stream
:type: bool
:value: >
   False

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.response_stream
```

````

````{py:attribute} message_name_constructor_class
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.message_name_constructor_class
:type: type[django_socio_grpc.protobuf.message_name_constructor.MessageNameConstructor]
:value: >
   None

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.message_name_constructor_class
```

````

````{py:attribute} use_generation_plugins
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.use_generation_plugins
:type: list[django_socio_grpc.protobuf.generation_plugin.BaseGenerationPlugin]
:value: >
   'field(...)'

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.use_generation_plugins
```

````

````{py:attribute} proto_rpc
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.proto_rpc
:type: django_socio_grpc.protobuf.proto_classes.ProtoRpc | None
:value: >
   'field(...)'

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.proto_rpc
```

````

````{py:method} __post_init__()
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.__post_init__

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.__post_init__
```

````

````{py:method} __set_name__(owner, name)
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.__set_name__

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.__set_name__
```

````

````{py:method} __hash__()
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.__hash__

````

````{py:method} __get__(obj, type=None)
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.__get__

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.__get__
```

````

````{py:method} __call__(*args, **kwargs)
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.__call__

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.__call__
```

````

````{py:method} get_action_params()
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.get_action_params

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.get_action_params
```

````

````{py:property} request_message_name
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.request_message_name
:type: str | None

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.request_message_name
```

````

````{py:property} response_message_name
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.response_message_name
:type: str | None

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.response_message_name
```

````

````{py:method} make_proto_rpc(action_name: str, service: type[django_socio_grpc.services.Service]) -> django_socio_grpc.protobuf.proto_classes.ProtoRpc
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.make_proto_rpc

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.make_proto_rpc
```

````

````{py:method} register(owner: type[django_socio_grpc.services.Service], action_name: str)
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.register

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.register
```

````

````{py:method} resolve_placeholders(service_class: type[django_socio_grpc.services.Service], action: str)
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.resolve_placeholders

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.resolve_placeholders
```

````

````{py:method} clone(**kwargs)
:canonical: django_socio_grpc.grpc_actions.actions.GRPCAction.clone

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCAction.clone
```

````

`````

````{py:function} register_action(cls, action_name: str, name: str | None = None, **kwargs)
:canonical: django_socio_grpc.grpc_actions.actions.register_action

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.register_action
```
````

`````{py:class} GRPCActionMixin
:canonical: django_socio_grpc.grpc_actions.actions.GRPCActionMixin

Bases: {py:obj}`abc.ABC`

````{py:attribute} _decorated_grpc_action_registry
:canonical: django_socio_grpc.grpc_actions.actions.GRPCActionMixin._decorated_grpc_action_registry
:type: dict[str, dict[str, typing.Any]]
:value: >
   None

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCActionMixin._decorated_grpc_action_registry
```

````

````{py:attribute} proto_service
:canonical: django_socio_grpc.grpc_actions.actions.GRPCActionMixin.proto_service
:type: django_socio_grpc.protobuf.proto_classes.ProtoService
:value: >
   None

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCActionMixin.proto_service
```

````

````{py:method} get_controller_name() -> str
:canonical: django_socio_grpc.grpc_actions.actions.GRPCActionMixin.get_controller_name
:abstractmethod:
:classmethod:

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCActionMixin.get_controller_name
```

````

````{py:method} before_registration(service_class=None)
:canonical: django_socio_grpc.grpc_actions.actions.GRPCActionMixin.before_registration
:classmethod:

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCActionMixin.before_registration
```

````

````{py:method} get_parents_action_registry(service)
:canonical: django_socio_grpc.grpc_actions.actions.GRPCActionMixin.get_parents_action_registry
:classmethod:

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCActionMixin.get_parents_action_registry
```

````

````{py:method} get_class_action_registry(service)
:canonical: django_socio_grpc.grpc_actions.actions.GRPCActionMixin.get_class_action_registry
:classmethod:

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCActionMixin.get_class_action_registry
```

````

````{py:method} get_action_parents()
:canonical: django_socio_grpc.grpc_actions.actions.GRPCActionMixin.get_action_parents
:classmethod:

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCActionMixin.get_action_parents
```

````

````{py:method} register_actions()
:canonical: django_socio_grpc.grpc_actions.actions.GRPCActionMixin.register_actions
:classmethod:

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCActionMixin.register_actions
```

````

````{py:method} _before_registration()
:canonical: django_socio_grpc.grpc_actions.actions.GRPCActionMixin._before_registration

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCActionMixin._before_registration
```

````

````{py:method} _dynamic_grpc_action_registry() -> dict[str, dict[str, typing.Any]]
:canonical: django_socio_grpc.grpc_actions.actions.GRPCActionMixin._dynamic_grpc_action_registry

```{autodoc2-docstring} django_socio_grpc.grpc_actions.actions.GRPCActionMixin._dynamic_grpc_action_registry
```

````

`````