rest_framework.serializers.Serializer

class documentation

class Serializer(BaseSerializer): (source)

Known subclasses: rest_framework.authtoken.serializers.AuthTokenSerializer, rest_framework.serializers.ModelSerializer

View In Hierarchy

Undocumented

Method __getitem__ Undocumented
Method __iter__ Undocumented
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 get_fields Returns a dictionary of {field_name: field_instance}.
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 Returns a list of validator callables.
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 We override the default `run_validation`, because the validation performed by validators and the `.validate()` method should be coerced into an error dictionary with a 'non_fields_error' key.
Method run_validators Add read_only fields with defaults to value before running validators.
Method to_internal_value Dict of native values <- Dict of primitive datatypes.
Method to_representation Object instance -> Dict of primitive datatypes.
Method validate Undocumented
Class Variable default_error_messages Undocumented
Property data Undocumented
Property errors Undocumented
Property fields A dictionary of {field_name: field_instance}.
Method _read_only_defaults Undocumented
Property _readable_fields Undocumented
Property _writable_fields Undocumented

Inherited from BaseSerializer:

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 update Undocumented
Instance Variable initial_data Undocumented
Instance Variable instance Undocumented
Instance Variable partial Undocumented
Property validated_data Undocumented
Instance Variable _context Undocumented
Instance Variable _validated_data Undocumented

Inherited from Field (via BaseSerializer):

Method __deepcopy__ When cloning fields we instantiate using the arguments it was originally created with, rather than copying the complete state.
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 validate_empty_values Validate empty values, and either:
Method validators.setter 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
def __getitem__(self, key): (source)

Undocumented

def __iter__(self): (source)

Undocumented

def __repr__(self): (source)
overrides rest_framework.fields.Field.__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.

def get_fields(self): (source)
overridden in rest_framework.serializers.ModelSerializer

Returns a dictionary of {field_name: field_instance}.

def get_initial(self): (source)
overrides rest_framework.fields.Field.get_initial

Return a value to use when the field is being returned as a primitive value, without any object instance.

def get_validators(self): (source)
overrides rest_framework.fields.Field.get_validators
overridden in rest_framework.serializers.ModelSerializer

Returns a list of validator callables.

def get_value(self, dictionary): (source)
overrides rest_framework.fields.Field.get_value

Given the *incoming* primitive data, return the value for this field that should be validated and transformed to a native value.

def run_validation(self, data=empty): (source)
overrides rest_framework.fields.Field.run_validation

We override the default `run_validation`, because the validation performed by validators and the `.validate()` method should be coerced into an error dictionary with a 'non_fields_error' key.

def run_validators(self, value): (source)
overrides rest_framework.fields.Field.run_validators

Add read_only fields with defaults to value before running validators.

def to_internal_value(self, data): (source)
overrides rest_framework.serializers.BaseSerializer.to_internal_value

Dict of native values <- Dict of primitive datatypes.

def to_representation(self, instance): (source)
overrides rest_framework.serializers.BaseSerializer.to_representation

Object instance -> Dict of primitive datatypes.

def validate(self, attrs): (source)
overridden in rest_framework.authtoken.serializers.AuthTokenSerializer

Undocumented

default_error_messages = (source)
overrides rest_framework.fields.Field.default_error_messages

Undocumented

@property
data = (source)
overrides rest_framework.serializers.BaseSerializer.data

Undocumented

@property
errors = (source)
overrides rest_framework.serializers.BaseSerializer.errors

Undocumented

@cached_property
fields = (source)

A dictionary of {field_name: field_instance}.

def _read_only_defaults(self): (source)

Undocumented

@property
_readable_fields = (source)

Undocumented

@property
_writable_fields = (source)

Undocumented