django.forms.fields.Field

class documentation

class Field: (source)

View In Hierarchy

Undocumented

Method	`__deepcopy__`	Undocumented
Method	`__init__`	Undocumented
Method	`bound_data`	Return the value that should be shown for this field on render of a bound form, given the submitted POST data for the field and the initial data, if any.
Method	`clean`	Validate the given value and return its "cleaned" value as an appropriate Python object. Raise ValidationError for any errors.
Method	`get_bound_field`	Return a BoundField instance that will be used when accessing the form field in a template.
Method	`has_changed`	Return True if data differs from initial.
Method	`prepare_value`	Undocumented
Method	`run_validators`	Undocumented
Method	`to_python`	Undocumented
Method	`validate`	Undocumented
Method	`widget_attrs`	Given a Widget instance (not a Widget class), return a dictionary of any HTML attributes that should be added to the Widget, based on this Field.
Class Variable	`default_error_messages`	Undocumented
Class Variable	`default_validators`	Undocumented
Class Variable	`empty_values`	Undocumented
Instance Variable	`disabled`	Undocumented
Instance Variable	`error_messages`	Undocumented
Instance Variable	`help_text`	Undocumented
Instance Variable	`initial`	Undocumented
Instance Variable	`label`	Undocumented
Instance Variable	`label_suffix`	Undocumented
Instance Variable	`localize`	Undocumented
Instance Variable	`required`	Undocumented
Instance Variable	`show_hidden_initial`	Undocumented
Instance Variable	`validators`	Undocumented
Instance Variable	`widget`	Undocumented

def __deepcopy__(self, memo): (source) ¶

overridden in django.forms.fields.ChoiceField, django.forms.fields.MultiValueField

Undocumented

def __init__(self, *, required=True, widget=None, label=None, initial=None, help_text='', error_messages=None, show_hidden_initial=False, validators=(), localize=False, disabled=False, label_suffix=None): (source) ¶

overridden in django.contrib.auth.forms.ReadOnlyPasswordHashField, django.contrib.gis.forms.fields.GeometryField, django.contrib.postgres.forms.array.SplitArrayField, django.forms.fields.BaseTemporalField, django.forms.fields.CharField, django.forms.fields.ChoiceField, django.forms.fields.ComboField, django.forms.fields.FileField, django.forms.fields.IntegerField, django.forms.fields.MultiValueField, django.forms.models.InlineForeignKeyField

Undocumented

def bound_data(self, data, initial): (source) ¶

overridden in django.forms.fields.FileField, django.forms.fields.JSONField

Return the value that should be shown for this field on render of a bound form, given the submitted POST data for the field and the initial data, if any. For most fields, this will simply be data; FileFields need to handle it a bit differently.

def clean(self, value): (source) ¶

overridden in django.contrib.gis.forms.fields.GeometryField, django.contrib.postgres.forms.array.SimpleArrayField, django.contrib.postgres.forms.array.SplitArrayField, django.forms.fields.ComboField, django.forms.fields.FileField, django.forms.fields.MultiValueField, django.forms.fields.TypedChoiceField, django.forms.fields.TypedMultipleChoiceField, django.forms.models.InlineForeignKeyField, django.forms.models.ModelMultipleChoiceField

Validate the given value and return its "cleaned" value as an appropriate Python object. Raise ValidationError for any errors.

def get_bound_field(self, form, field_name): (source) ¶

Return a BoundField instance that will be used when accessing the form field in a template.

def has_changed(self, initial, data): (source) ¶

overridden in django.contrib.gis.forms.fields.GeometryField, django.contrib.postgres.forms.array.SimpleArrayField, django.contrib.postgres.forms.array.SplitArrayField, django.contrib.postgres.forms.hstore.HStoreField, django.forms.fields.BooleanField, django.forms.fields.FileField, django.forms.fields.JSONField, django.forms.fields.MultipleChoiceField, django.forms.fields.MultiValueField, django.forms.models.InlineForeignKeyField, django.forms.models.ModelChoiceField

Return True if data differs from initial.

def prepare_value(self, value): (source) ¶

overridden in django.contrib.postgres.forms.array.SimpleArrayField, django.contrib.postgres.forms.hstore.HStoreField, django.contrib.postgres.forms.ranges.BaseRangeField, django.forms.fields.DateTimeField, django.forms.fields.DurationField, django.forms.fields.JSONField, django.forms.fields.UUIDField, django.forms.models.ModelChoiceField

Undocumented

def run_validators(self, value): (source) ¶

overridden in django.contrib.postgres.forms.array.SimpleArrayField

Undocumented

def to_python(self, value): (source) ¶

overridden in django.contrib.gis.forms.fields.GeometryField, django.contrib.postgres.forms.array.SplitArrayField, django.forms.fields.BaseTemporalField, django.forms.fields.BooleanField, django.forms.fields.CharField, django.forms.fields.ChoiceField, django.forms.fields.DurationField, django.forms.fields.FileField, django.forms.fields.IntegerField

Undocumented

def validate(self, value): (source) ¶

overridden in django.contrib.postgres.forms.array.SimpleArrayField, django.forms.fields.BooleanField, django.forms.fields.ChoiceField, django.forms.fields.DecimalField, django.forms.fields.FloatField, django.forms.fields.MultiValueField

Undocumented

def widget_attrs(self, widget): (source) ¶

overridden in django.forms.fields.CharField, django.forms.fields.ImageField, django.forms.fields.IntegerField

Given a Widget instance (*not* a Widget class), return a dictionary of any HTML attributes that should be added to the Widget, based on this Field.

default_validators: list = (source) ¶

overridden in django.forms.fields.EmailField, django.forms.fields.GenericIPAddressField, django.forms.fields.ImageField, django.forms.fields.SlugField, django.forms.fields.URLField

Undocumented

empty_values = (source) ¶

Undocumented

disabled = (source) ¶

Undocumented

error_messages = (source) ¶

Undocumented

help_text = (source) ¶

Undocumented

initial = (source) ¶

Undocumented

label = (source) ¶