# {py:mod}`django_socio_grpc.proto_serializers`

```{py:module} django_socio_grpc.proto_serializers
```

```{autodoc2-docstring} django_socio_grpc.proto_serializers
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`BaseProtoSerializer <django_socio_grpc.proto_serializers.BaseProtoSerializer>`
  -
* - {py:obj}`ProtoSerializer <django_socio_grpc.proto_serializers.ProtoSerializer>`
  -
* - {py:obj}`ListProtoSerializer <django_socio_grpc.proto_serializers.ListProtoSerializer>`
  -
* - {py:obj}`PropertyReadOnlyField <django_socio_grpc.proto_serializers.PropertyReadOnlyField>`
  -
* - {py:obj}`ModelProtoSerializer <django_socio_grpc.proto_serializers.ModelProtoSerializer>`
  -
* - {py:obj}`BinaryField <django_socio_grpc.proto_serializers.BinaryField>`
  - ```{autodoc2-docstring} django_socio_grpc.proto_serializers.BinaryField
    :summary:
    ```
* - {py:obj}`SlugRelatedConvertedField <django_socio_grpc.proto_serializers.SlugRelatedConvertedField>`
  - ```{autodoc2-docstring} django_socio_grpc.proto_serializers.SlugRelatedConvertedField
    :summary:
    ```
````

### Functions

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

* - {py:obj}`get_default_value <django_socio_grpc.proto_serializers.get_default_value>`
  - ```{autodoc2-docstring} django_socio_grpc.proto_serializers.get_default_value
    :summary:
    ```
````

### Data

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

* - {py:obj}`LIST_PROTO_SERIALIZER_KWARGS <django_socio_grpc.proto_serializers.LIST_PROTO_SERIALIZER_KWARGS>`
  - ```{autodoc2-docstring} django_socio_grpc.proto_serializers.LIST_PROTO_SERIALIZER_KWARGS
    :summary:
    ```
````

### API

````{py:data} LIST_PROTO_SERIALIZER_KWARGS
:canonical: django_socio_grpc.proto_serializers.LIST_PROTO_SERIALIZER_KWARGS
:value: >
   ()

```{autodoc2-docstring} django_socio_grpc.proto_serializers.LIST_PROTO_SERIALIZER_KWARGS
```

````

```{py:exception} _NoDictData()
:canonical: django_socio_grpc.proto_serializers._NoDictData

Bases: {py:obj}`Exception`

```

````{py:function} get_default_value(field_default)
:canonical: django_socio_grpc.proto_serializers.get_default_value

```{autodoc2-docstring} django_socio_grpc.proto_serializers.get_default_value
```
````

``````{py:class} BaseProtoSerializer(*args, **kwargs)
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer

Bases: {py:obj}`rest_framework.serializers.BaseSerializer`

````{py:attribute} fields
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer.fields
:type: dict[str, rest_framework.serializers.Field]
:value: >
   None

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer.fields
```

````

````{py:method} message_to_data(message)
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer.message_to_data

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer.message_to_data
```

````

````{py:method} data_to_message(data)
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer.data_to_message

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer.data_to_message
```

````

````{py:property} message
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer.message

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer.message
```

````

````{py:method} asave(**kwargs)
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer.asave
:async:

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer.asave
```

````

````{py:method} ais_valid(*, raise_exception=False)
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer.ais_valid
:async:

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer.ais_valid
```

````

````{py:method} acreate(validated_data)
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer.acreate
:async:

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer.acreate
```

````

````{py:method} aupdate(instance, validated_data)
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer.aupdate
:async:

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer.aupdate
```

````

````{py:property} adata
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer.adata

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer.adata
```

````

````{py:property} amessage
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer.amessage

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer.amessage
```

````

````{py:method} many_init(*args, **kwargs)
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer.many_init
:classmethod:

````

````{py:method} to_proto_message()
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer.to_proto_message
:abstractmethod:

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer.to_proto_message
```

````

`````{py:class} _MessageToData(message, serializer)
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData
```

```{rubric} Initialization
```

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData.__init__
```

````{py:property} partial_fields
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData.partial_fields

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData.partial_fields
```

````

````{py:method} get_data()
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData.get_data

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData.get_data
```

````

````{py:method} is_field_accept_null_value(field: rest_framework.serializers.Field) -> bool
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData.is_field_accept_null_value

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData.is_field_accept_null_value
```

````

````{py:method} get_default_field_value(field: rest_framework.serializers.Field)
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData.get_default_field_value

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData.get_default_field_value
```

````

````{py:method} get_nullable_field_value(field: rest_framework.serializers.Field, force_default: bool = False)
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData.get_nullable_field_value

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData.get_nullable_field_value
```

````

````{py:method} get_partial_field_value(field: rest_framework.serializers.Field)
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData.get_partial_field_value

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData.get_partial_field_value
```

````

````{py:method} get_cleaned_field_value(field: rest_framework.serializers.Field)
:canonical: django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData.get_cleaned_field_value

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BaseProtoSerializer._MessageToData.get_cleaned_field_value
```

````

`````

``````

```{py:class} ProtoSerializer(*args, **kwargs)
:canonical: django_socio_grpc.proto_serializers.ProtoSerializer

Bases: {py:obj}`django_socio_grpc.proto_serializers.BaseProtoSerializer`, {py:obj}`rest_framework.serializers.Serializer`

```

`````{py:class} ListProtoSerializer(*args, **kwargs)
:canonical: django_socio_grpc.proto_serializers.ListProtoSerializer

Bases: {py:obj}`rest_framework.serializers.ListSerializer`, {py:obj}`django_socio_grpc.proto_serializers.BaseProtoSerializer`

````{py:method} message_to_data(message)
:canonical: django_socio_grpc.proto_serializers.ListProtoSerializer.message_to_data

```{autodoc2-docstring} django_socio_grpc.proto_serializers.ListProtoSerializer.message_to_data
```

````

````{py:method} data_to_message(data)
:canonical: django_socio_grpc.proto_serializers.ListProtoSerializer.data_to_message

```{autodoc2-docstring} django_socio_grpc.proto_serializers.ListProtoSerializer.data_to_message
```

````

`````

`````{py:class} PropertyReadOnlyField(**kwargs)
:canonical: django_socio_grpc.proto_serializers.PropertyReadOnlyField

Bases: {py:obj}`rest_framework.serializers.ReadOnlyField`, {py:obj}`django_socio_grpc.protobuf.proto_classes.ProtoFieldConvertible`

````{py:method} to_proto_field(proto_field_class: django_socio_grpc.protobuf.proto_classes.ProtoField = ProtoField, **kwargs) -> django_socio_grpc.protobuf.proto_classes.ProtoField
:canonical: django_socio_grpc.proto_serializers.PropertyReadOnlyField.to_proto_field

```{autodoc2-docstring} django_socio_grpc.proto_serializers.PropertyReadOnlyField.to_proto_field
```

````

`````

``````{py:class} ModelProtoSerializer(*args, **kwargs)
:canonical: django_socio_grpc.proto_serializers.ModelProtoSerializer

Bases: {py:obj}`django_socio_grpc.proto_serializers.ProtoSerializer`, {py:obj}`rest_framework.serializers.ModelSerializer`

````{py:method} build_property_field(field_name, model_class)
:canonical: django_socio_grpc.proto_serializers.ModelProtoSerializer.build_property_field

```{autodoc2-docstring} django_socio_grpc.proto_serializers.ModelProtoSerializer.build_property_field
```

````

`````{py:class} _MessageToData(message, serializer)
:canonical: django_socio_grpc.proto_serializers.ModelProtoSerializer._MessageToData

Bases: {py:obj}`django_socio_grpc.proto_serializers.ProtoSerializer`

```{autodoc2-docstring} django_socio_grpc.proto_serializers.ModelProtoSerializer._MessageToData
```

```{rubric} Initialization
```

```{autodoc2-docstring} django_socio_grpc.proto_serializers.ModelProtoSerializer._MessageToData.__init__
```

````{py:property} model
:canonical: django_socio_grpc.proto_serializers.ModelProtoSerializer._MessageToData.model

```{autodoc2-docstring} django_socio_grpc.proto_serializers.ModelProtoSerializer._MessageToData.model
```

````

````{py:property} updating
:canonical: django_socio_grpc.proto_serializers.ModelProtoSerializer._MessageToData.updating

```{autodoc2-docstring} django_socio_grpc.proto_serializers.ModelProtoSerializer._MessageToData.updating
```

````

````{py:method} get_default_field_value(field: rest_framework.serializers.Field)
:canonical: django_socio_grpc.proto_serializers.ModelProtoSerializer._MessageToData.get_default_field_value

```{autodoc2-docstring} django_socio_grpc.proto_serializers.ModelProtoSerializer._MessageToData.get_default_field_value
```

````

````{py:method} get_nullable_field_value(field: rest_framework.serializers.Field, force_default: bool = False)
:canonical: django_socio_grpc.proto_serializers.ModelProtoSerializer._MessageToData.get_nullable_field_value

```{autodoc2-docstring} django_socio_grpc.proto_serializers.ModelProtoSerializer._MessageToData.get_nullable_field_value
```

````

`````

``````

`````{py:class} BinaryField(**kwargs)
:canonical: django_socio_grpc.proto_serializers.BinaryField

Bases: {py:obj}`rest_framework.serializers.Field`

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BinaryField
```

```{rubric} Initialization
```

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BinaryField.__init__
```

````{py:attribute} default_error_messages
:canonical: django_socio_grpc.proto_serializers.BinaryField.default_error_messages
:value: >
   None

```{autodoc2-docstring} django_socio_grpc.proto_serializers.BinaryField.default_error_messages
```

````

````{py:method} to_internal_value(data)
:canonical: django_socio_grpc.proto_serializers.BinaryField.to_internal_value

````

````{py:method} to_representation(value)
:canonical: django_socio_grpc.proto_serializers.BinaryField.to_representation

````

`````

`````{py:class} SlugRelatedConvertedField(convert_type=None, **kwargs)
:canonical: django_socio_grpc.proto_serializers.SlugRelatedConvertedField

Bases: {py:obj}`rest_framework.relations.SlugRelatedField`

```{autodoc2-docstring} django_socio_grpc.proto_serializers.SlugRelatedConvertedField
```

```{rubric} Initialization
```

```{autodoc2-docstring} django_socio_grpc.proto_serializers.SlugRelatedConvertedField.__init__
```

````{py:method} to_representation(obj)
:canonical: django_socio_grpc.proto_serializers.SlugRelatedConvertedField.to_representation

````

`````