drf_dynamic_serializers.mixins module

class drf_dynamic_serializers.mixins.DynamicFieldsPolymorphicSerializerMixin(*args, **kwargs)

Bases: object

Mixin that implements dynamic fields for PolymorphicSerializers (see https://github.com/apirobot/django-rest-polymorphic).

dynamic_fields = True

set_df_config(config: drf_dynamic_serializers.conf.DynamicFieldsConfig) → None

Set config ‘config’ as dynamic fields config.

to_resource_type: Callable

class drf_dynamic_serializers.mixins.DynamicFieldsSerializerMixin(*args, **kwargs)

Bases: object

Mixin that adds the ability to dynamically configure a serializer’s fields. Fields can be included and/or excluded and the ‘required’ and ‘allow_null’ properties of fields can be overridden.

dynamic_fields = True

fields

Get fields to serialize given the fields to include and fields to exclude.

set_df_config(config: drf_dynamic_serializers.conf.DynamicFieldsConfig)

Set config ‘config’ as dynamic fields config.

class drf_dynamic_serializers.mixins.DynamicFieldsViewMixin

Bases: object

Mixin for view(set)s that adds the ability to dynamically select the fields to include or exclude in a response by reading the query parameters in the request.

default_excluded_fields: List[str]

default_included_fields: List[str]

get_serializer(*args, **kwargs) → rest_framework.serializers.Serializer

Get serializer given the dynamically excluded and/or included fields.

get_serializer_class: Callable

get_serializer_context: Callable

request: rest_framework.request.Request