rest_framework.fields.UUIDField

class documentation

class UUIDField(Field): (source)

View In Hierarchy

Undocumented

Method __init__ 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.
Class Variable default_error_messages Undocumented
Class Variable valid_formats Undocumented
Instance Variable uuid_format 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 __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 __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_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 __init__(self, **kwargs): (source)
overrides rest_framework.fields.Field.__init__

Undocumented

def to_internal_value(self, data): (source)
overrides rest_framework.fields.Field.to_internal_value

Transform the *incoming* primitive data into a native value.

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

Transform the *outgoing* native value into primitive data.

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

Undocumented

valid_formats: tuple[str, ...] = (source)

Undocumented

uuid_format = (source)

Undocumented