rest_framework.serializers.BaseSerializer

class documentation

class BaseSerializer(Field): (source)

Known subclasses: rest_framework.serializers.ListSerializer, rest_framework.serializers.Serializer

The BaseSerializer class provides a minimal class which may be used for writing custom serializer implementations. Note that we strongly restrict the ordering of operations/properties that may be used on the serializer in order to enforce correct usage. In particular, if a `data=` argument is passed then: .is_valid() - Available. .initial_data - Available. .validated_data - Only available after calling `is_valid()` .errors - Only available after calling `is_valid()` .data - Only available after calling `is_valid()` If a `data=` argument is not passed then: .is_valid() - Not available. .initial_data - Not available. .validated_data - Not available. .errors - Not available. .data - Available.

Class Method	`many_init`	This method implements the creation of a `ListSerializer` parent class when `many=True` is used. You can customize it if you need to control which keyword arguments are passed to the parent, and which are passed to the child.
Method	`__class_getitem__`	Undocumented
Method	`__init__`	Undocumented
Method	`__new__`	When a field is instantiated, we store the arguments that were used, so that we can present a helpful representation of the object.
Method	`create`	Undocumented
Method	`is_valid`	Undocumented
Method	`save`	Undocumented
Method	`to_internal_value`	Transform the incoming primitive data into a native value.
Method	`to_representation`	Transform the outgoing native value into primitive data.
Method	`update`	Undocumented
Instance Variable	`initial_data`	Undocumented
Instance Variable	`instance`	Undocumented
Instance Variable	`partial`	Undocumented
Property	`data`	Undocumented
Property	`errors`	Undocumented
Property	`validated_data`	Undocumented
Instance Variable	`_context`	Undocumented
Instance Variable	`_validated_data`	Undocumented

Inherited from Field:

Method	`__deepcopy__`	When cloning fields we instantiate using the arguments it was originally created with, rather than copying the complete state.
Method	`__repr__`	Fields are represented using their initial calling arguments. This allows us to create descriptive representations for serializer instances that show all the declared fields on the serializer.
Method	`bind`	Initializes the field name and parent for the field instance. Called when a field is added to the parent serializer instance.
Method	`fail`	A helper method that simply raises a validation error.
Method	`get_attribute`	Given the outgoing object instance, return the primitive value that should be used for this field.
Method	`get_default`	Return the default value to use when validating data if no input is provided for this field.
Method	`get_initial`	Return a value to use when the field is being returned as a primitive value, without any object instance.
Method	`get_validators`	Undocumented
Method	`get_value`	Given the incoming primitive data, return the value for this field that should be validated and transformed to a native value.
Method	`run_validation`	Validate a simple representation and return the internal value.
Method	`run_validators`	Test the given value against all the validators on the field, and either raise a `ValidationError` or simply return.
Method	`validate_empty_values`	Validate empty values, and either:
Method	`validators.setter`	Undocumented
Class Variable	`default_error_messages`	Undocumented
Class Variable	`default_validators`	Undocumented
Instance Variable	`allow_null`	Undocumented
Instance Variable	`default`	Undocumented
Instance Variable	`default_empty_html`	Undocumented
Instance Variable	`error_messages`	Undocumented
Instance Variable	`field_name`	Undocumented
Instance Variable	`help_text`	Undocumented
Instance Variable	`initial`	Undocumented
Instance Variable	`label`	Undocumented
Instance Variable	`parent`	Undocumented
Instance Variable	`read_only`	Undocumented
Instance Variable	`required`	Undocumented
Instance Variable	`source`	Undocumented
Instance Variable	`source_attrs`	Undocumented
Instance Variable	`style`	Undocumented
Instance Variable	`write_only`	Undocumented
Property	`context`	Returns the context as passed to the root serializer on initialization.
Property	`root`	Returns the top-level serializer for this field.
Property	`validators`	Undocumented
Instance Variable	`_creation_counter`	Undocumented
Instance Variable	`_validators`	Undocumented

@classmethod
def many_init(cls, *args, **kwargs): (source) ¶

This method implements the creation of a `ListSerializer` parent class when `many=True` is used. You can customize it if you need to control which keyword arguments are passed to the parent, and which are passed to the child. Note that we're over-cautious in passing most arguments to both parent and child classes in order to try to cover the general case. If you're overriding this method you'll probably want something much simpler, eg: @classmethod def many_init(cls, *args, **kwargs): kwargs['child'] = cls() return CustomListSerializer(*args, **kwargs)

def __class_getitem__(cls, *args, **kwargs): (source) ¶

Undocumented

def __init__(self, instance=None, data=empty, **kwargs): (source) ¶

overrides rest_framework.fields.Field.__init__

overridden in rest_framework.serializers.ListSerializer

Undocumented

def __new__(cls, *args, **kwargs): (source) ¶

overrides rest_framework.fields.Field.__new__

When a field is instantiated, we store the arguments that were used, so that we can present a helpful representation of the object.

def create(self, validated_data): (source) ¶

overridden in rest_framework.serializers.ListSerializer, rest_framework.serializers.ModelSerializer

Undocumented