{"title":"Formulärfält","version":"5.2","locale":"sv","docname":"ref/forms/fields","url":"/sv/5.2/ref/forms/fields/","canonical":"https://djangodocs.dev/sv/5.2/ref/forms/fields/","summary":"class Field Link to this definition # När du skapar en Form -klass är den viktigaste delen att definiera fälten i formuläret. Varje fält har en anpassad…","html":"

FormulärfältLink to this heading#

\n
\n
\nclass FieldLink to this definition#
\n
\n\n

När du skapar en Form-klass är den viktigaste delen att definiera fälten i formuläret. Varje fält har en anpassad valideringslogik, tillsammans med några andra hooks.

\n
\n
\nField.clean(value)Link to this definition#
\n
\n\n

Även om det primära sättet du kommer att använda Field-klasser är i Form-klasser, kan du också instansiera dem och använda dem direkt för att få en bättre uppfattning om hur de fungerar. Varje Field-instans har en clean()-metod, som tar ett enda argument och antingen ger upphov till ett django.core.exceptions.ValidationError-undantag eller returnerar det rena värdet:

\n
Python console
>>> from django import forms\n>>> f = forms.EmailField()\n>>> f.clean("foo@example.com")\n'foo@example.com'\n>>> f.clean("invalid email address")\nTraceback (most recent call last):\n...\nValidationError: ['Enter a valid email address.']\n
\n
\n

Argument för kärnområdetLink to this heading#

\n

Varje Field-klass konstruktör tar minst dessa argument. Vissa Field-klasser tar ytterligare fältspecifika argument, men följande bör alltid accepteras:

\n
\n

krävsLink to this heading#

\n
\n
\nField.requiredLink to this definition#
\n
\n\n

Som standard antar varje Field-klass att värdet är obligatoriskt, så om du skickar ett tomt värde - antingen None eller den tomma strängen ("") - kommer clean() att ge upphov till ett ValidationError undantag:

\n
Python console
>>> from django import forms\n>>> f = forms.CharField()\n>>> f.clean("foo")\n'foo'\n>>> f.clean("")\nTraceback (most recent call last):\n...\nValidationError: ['This field is required.']\n>>> f.clean(None)\nTraceback (most recent call last):\n...\nValidationError: ['This field is required.']\n>>> f.clean(0)\n'0'\n>>> f.clean(True)\n'True'\n>>> f.clean(False)\n'False'\n
\n

För att ange att ett fält inte är obligatoriskt, skicka required=False till konstruktören Field:

\n
Python console
>>> f = forms.CharField(required=False)\n>>> f.clean("foo")\n'foo'\n>>> f.clean("")\n''\n>>> f.clean(None)\n''\n>>> f.clean(0)\n'0'\n>>> f.clean(True)\n'True'\n>>> f.clean(False)\n'False'\n
\n

Om en Field har required=False och du ger clean() ett tomt värde, så kommer clean() att returnera ett normaliserat tomt värde istället för att ge upphov till ValidationError. För CharField kommer detta att returnera empty_value som standard är en tom sträng. För andra klasser av Field kan det vara None. (Detta varierar från fält till fält.)

\n

Widgets för obligatoriska formulärfält har HTML-attributet required. Ställ in attributet Form.use_required_attribute till False för att inaktivera det. Attributet required ingår inte i formulär för formuläruppsättningar eftersom webbläsarens validering kanske inte är korrekt när formuläruppsättningar läggs till och tas bort.

\n
\n
\n

etikettLink to this heading#

\n
\n
\nField.labelLink to this definition#
\n
\n\n

Med argumentet label kan du ange den ”människovänliga” etiketten för detta fält. Detta används när Field visas i en Form.

\n

Som förklaras i Utmatning av formulär som HTML, genereras standardetiketten för ett Field från fältnamnet genom att konvertera alla understreck till mellanslag och versera första bokstaven. Ange label om detta standardbeteende inte resulterar i en lämplig etikett.

\n

Här är ett fullständigt exempel på Form som implementerar label för två av sina fält. Vi har angett auto_id=False för att förenkla utdata:

\n
Python console
>>> from django import forms\n>>> class CommentForm(forms.Form):\n...     name = forms.CharField(label="Your name")\n...     url = forms.URLField(label="Your website", required=False)\n...     comment = forms.CharField()\n...\n>>> f = CommentForm(auto_id=False)\n>>> print(f)\n<div>Your name:<input type="text" name="name" required></div>\n<div>Your website:<input type="url" name="url"></div>\n<div>Comment:<input type="text" name="comment" required></div>\n
\n
\n
\n

label_suffixLink to this heading#

\n
\n
\nField.label_suffixLink to this definition#
\n
\n\n

Med argumentet label_suffix kan du åsidosätta formulärets label_suffix för varje enskilt fält:

\n
Python console
>>> class ContactForm(forms.Form):\n...     age = forms.IntegerField()\n...     nationality = forms.CharField()\n...     captcha_answer = forms.IntegerField(label="2 + 2", label_suffix=" =")\n...\n>>> f = ContactForm(label_suffix="?")\n>>> print(f)\n<div><label for="id_age">Age?</label><input type="number" name="age" required id="id_age"></div>\n<div><label for="id_nationality">Nationality?</label><input type="text" name="nationality" required id="id_nationality"></div>\n<div><label for="id_captcha_answer">2 + 2 =</label><input type="number" name="captcha_answer" required id="id_captcha_answer"></div>\n
\n
\n
\n

initialLink to this heading#

\n
\n
\nField.initialLink to this definition#
\n
\n\n

Med argumentet initial kan du ange det initiala värde som ska användas när detta Field återges i ett obundet Form.

\n

För att ange dynamiska initialdata, se parametern Form.initial.

\n

Användningsfallet för detta är när du vill visa ett ”tomt” formulär där ett fält är initialiserat till ett visst värde. Ett exempel:

\n
Python console
>>> from django import forms\n>>> class CommentForm(forms.Form):\n...     name = forms.CharField(initial="Your name")\n...     url = forms.URLField(initial="https://")\n...     comment = forms.CharField()\n...\n>>> f = CommentForm(auto_id=False)\n>>> print(f)\n<div>Name:<input type="text" name="name" value="Your name" required></div>\n<div>Url:<input type="url" name="url" value="https://" required></div>\n<div>Comment:<input type="text" name="comment" required></div>\n
\n

Du kanske tänker, varför inte bara skicka en ordbok med de ursprungliga värdena som data när du visar formuläret? Tja, om du gör det kommer du att utlösa validering och HTML-utdata kommer att innehålla eventuella valideringsfel:

\n
Python console
>>> class CommentForm(forms.Form):\n...     name = forms.CharField()\n...     url = forms.URLField()\n...     comment = forms.CharField()\n...\n>>> default_data = {"name": "Your name", "url": "https://"}\n>>> f = CommentForm(default_data, auto_id=False)\n>>> print(f)\n<div>Name:\n  <input type="text" name="name" value="Your name" required>\n</div>\n<div>Url:\n  <ul class="errorlist"><li>Enter a valid URL.</li></ul>\n  <input type="url" name="url" value="https://" required aria-invalid="true">\n</div>\n<div>Comment:\n  <ul class="errorlist"><li>This field is required.</li></ul>\n  <input type="text" name="comment" required aria-invalid="true">\n</div>\n
\n

Det är därför som ”initial”-värden bara visas för obundna formulär. För bundna formulär kommer HTML-utdata att använda de bundna uppgifterna.

\n

Observera också att ”initiala” värden inte används som ”fallback”-data vid validering om värdet för ett visst fält inte anges. initial-värden är endast avsedda för initial visning av formuläret:

\n
Python console
>>> class CommentForm(forms.Form):\n...     name = forms.CharField(initial="Your name")\n...     url = forms.URLField(initial="https://")\n...     comment = forms.CharField()\n...\n>>> data = {"name": "", "url": "", "comment": "Foo"}\n>>> f = CommentForm(data)\n>>> f.is_valid()\nFalse\n# The form does *not* fallback to using the initial values.\n>>> f.errors\n{'url': ['This field is required.'], 'name': ['This field is required.']}\n
\n

I stället för en konstant kan du också skicka en valfri callable:

\n
Python console
>>> import datetime\n>>> class DateForm(forms.Form):\n...     day = forms.DateField(initial=datetime.date.today)\n...\n>>> print(DateForm())\n<div><label for="id_day">Day:</label><input type="text" name="day" value="2023-02-11" required id="id_day"></div>\n
\n

Callable kommer att utvärderas först när det obundna formuläret visas, inte när det definieras.

\n
\n
\n

widgetLink to this heading#

\n
\n
\nField.widgetLink to this definition#
\n
\n\n

Med argumentet widget kan du ange en Widget-klass som ska användas vid rendering av detta Field. Se Widgets för mer information.

\n
\n
\n

hjälp_textLink to this heading#

\n
\n
\nField.help_textLink to this definition#
\n
\n\n

Med argumentet help_text kan du ange en beskrivande text för detta Field. Om du anger help_text kommer den att visas bredvid Field när Field återges med en av de praktiska Form-metoderna (t.ex. as_ul()).

\n

Precis som modellfältets help_text, är detta värde inte HTML-escaped i automatiskt genererade formulär.

\n

Här är ett fullständigt exempel på en Form som implementerar help_text för två av sina fält. Vi har angett auto_id=False för att förenkla utdata:

\n
Python console
>>> from django import forms\n>>> class HelpTextContactForm(forms.Form):\n...     subject = forms.CharField(max_length=100, help_text="100 characters max.")\n...     message = forms.CharField()\n...     sender = forms.EmailField(help_text="A valid email address, please.")\n...     cc_myself = forms.BooleanField(required=False)\n...\n>>> f = HelpTextContactForm(auto_id=False)\n>>> print(f)\n<div>Subject:<div class="helptext">100 characters max.</div><input type="text" name="subject" maxlength="100" required></div>\n<div>Message:<input type="text" name="message" required></div>\n<div>Sender:<div class="helptext">A valid email address, please.</div><input type="email" name="sender" required></div>\n<div>Cc myself:<input type="checkbox" name="cc_myself"></div>\n
\n

När ett fält har en hjälptext associeras den med dess inmatning med hjälp av HTML-attributet aria-describedby. Om widgeten återges i en <fieldset> läggs aria-describedby till i detta element, annars läggs det till i widgetens <input>:

\n
Python console
>>> from django import forms\n>>> class UserForm(forms.Form):\n...     username = forms.CharField(max_length=255, help_text="e.g., user@example.com")\n...\n>>> f = UserForm()\n>>> print(f)\n<div>\n<label for="id_username">Username:</label>\n<div class="helptext" id="id_username_helptext">e.g., user@example.com</div>\n<input type="text" name="username" maxlength="255" required aria-describedby="id_username_helptext" id="id_username">\n</div>\n
\n

När du lägger till ett anpassat aria-describedby-attribut, se till att även inkludera id för help_text-elementet (om det används) i önskad ordning. För användare av skärmläsare kommer beskrivningarna att läsas i den ordning de förekommer i aria-describedby:

\n
Python console
>>> class UserForm(forms.Form):\n...     username = forms.CharField(\n...         max_length=255,\n...         help_text="e.g., user@example.com",\n...         widget=forms.TextInput(\n...             attrs={"aria-describedby": "custom-description id_username_helptext"},\n...         ),\n...     )\n...\n>>> f = UserForm()\n>>> print(f["username"])\n<input type="text" name="username" aria-describedby="custom-description id_username_helptext" maxlength="255" id="id_username" required>\n
\n\n
\n
\n

FelmeddelandenLink to this heading#

\n
\n
\nField.error_messagesLink to this definition#
\n
\n\n

Med argumentet error_messages kan du åsidosätta de standardmeddelanden som fältet kommer att ge upphov till. Skicka in en ordbok med nycklar som matchar de felmeddelanden som du vill åsidosätta. Här är t.ex. standardfelmeddelandet:

\n
Python console
>>> from django import forms\n>>> generic = forms.CharField()\n>>> generic.clean("")\nTraceback (most recent call last):\n  ...\nValidationError: ['This field is required.']\n
\n

Och här är ett anpassat felmeddelande:

\n
Python console
>>> name = forms.CharField(error_messages={"required": "Please enter your name"})\n>>> name.clean("")\nTraceback (most recent call last):\n  ...\nValidationError: ['Please enter your name']\n
\n

I avsnittet inbyggda fältklasser nedan definierar varje fält de felmeddelandenycklar som används.

\n
\n
\n

validerareLink to this heading#

\n
\n
\nField.validatorsLink to this definition#
\n
\n\n

Med argumentet validators kan du ange en lista över valideringsfunktioner för detta fält.

\n

Se validators dokumentation för mer information.

\n
\n
\n

lokaliseraLink to this heading#

\n
\n
\nField.localizeLink to this definition#
\n
\n\n

Argumentet localize gör det möjligt att lokalisera inmatning av formulärdata samt den renderade utdata.

\n

Se format localization documentation för mer information.

\n
\n
\n

inaktiveradLink to this heading#

\n
\n
\nField.disabledLink to this definition#
\n
\n\n

Det booleska argumentet disabled, när det sätts till True, inaktiverar ett formulärfält som använder HTML-attributet disabled så att det inte kan redigeras av användarna. Även om en användare manipulerar fältets värde som skickas till servern, kommer det att ignoreras till förmån för värdet från formulärets ursprungliga data.

\n
\n
\n

template_nameLink to this heading#

\n
\n
\nField.template_nameLink to this definition#
\n
\n\n

Argumentet template_name tillåter en anpassad mall som ska användas när fältet återges med as_field_group(). Som standard är detta värde inställt på "django/forms/field.html". Kan ändras per fält genom att åsidosätta detta attribut eller mer allmänt genom att åsidosätta standardmallen, se även Åsidosätta inbyggda fältmallar.

\n
\n
\n

bound_field_classLink to this heading#

\n
\n
\nField.bound_field_classLink to this definition#
\n
\n\n\n

Attributet bound_field_class gör det möjligt att för varje fält åsidosätta Form.bound_field_class.

\n
\n
\n
\n

Kontroll av om fältdata har ändratsLink to this heading#

\n
\n

has_changed()Link to this heading#

\n
\n
\nField.has_changed()Link to this definition#
\n
\n\n

Metoden has_changed() används för att avgöra om fältvärdet har ändrats från det ursprungliga värdet. Returnerar True eller False.

\n

Se Form.has_changed()-dokumentationen för mer information.

\n
\n
\n
\n

Inbyggda Field-klasserLink to this heading#

\n

Biblioteket forms levereras naturligtvis med en uppsättning Field-klasser som representerar vanliga valideringsbehov. Detta avsnitt dokumenterar varje inbyggt fält.

\n

För varje fält beskriver vi den standardwidget som används om du inte anger widget. Vi anger också det värde som returneras när du anger ett tomt värde (se avsnittet om required ovan för att förstå vad det betyder).

\n
\n

BooleanFieldLink to this heading#

\n
\n
\nclass BooleanField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: CheckboxInput

    • \n

  • Tomt värde: False

    • \n

  • Normaliseras till: Ett Python-värde av typen True eller False.

    • \n

  • Validerar att värdet är True (t.ex. att kryssrutan är markerad) om fältet har required=True.

    • \n

  • Felmeddelande nycklar: krävs

    • \n
\n\n
\n\n
\n
\n

CharFieldLink to this heading#

\n
\n
\nclass CharField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: TextInput

    • \n

  • Tomt värde: Vad du än har angett som empty_value.

    • \n

  • Normaliseras till: En sträng.

    • \n

  • Använder MaxLengthValidator och MinLengthValidator om max_length och min_length anges. Annars är alla inmatningar giltiga.

    • \n

  • Nycklar för felmeddelande: required, max_length, min_length

    • \n
\n

Har följande valfria argument för validering:

\n
\n
\nmax_lengthLink to this definition#
\n
\n\n
\n
\nmin_lengthLink to this definition#
\n

Om dessa argument anges säkerställer de att strängen är högst eller minst den angivna längden.

\n
\n\n
\n
\nstripLink to this definition#
\n

Om True (standard), kommer värdet att rensas från inledande och efterföljande blanksteg.

\n
\n\n
\n
\nempty_valueLink to this definition#
\n

Det värde som ska användas för att representera ”tom”. Standardvärdet är en tom sträng.

\n
\n\n
\n\n
\n
\n

ValFieldLink to this heading#

\n
\n
\nclass ChoiceField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: Select

    • \n

  • Tomt värde: '' (en tom sträng)

    • \n

  • Normaliseras till: En sträng.

    • \n

  • Validerar att det angivna värdet finns i listan med valmöjligheter.

    • \n

  • Nycklar för felmeddelanden: krävs, ogiltigt_val

    • \n
\n

Felmeddelandet invalid_choice kan innehålla %(value)s, som kommer att ersättas med det valda alternativet.

\n

Kräver ett extra argument:

\n
\n
\nchoicesLink to this definition#
\n

Antingen en iterabel av 2-tuples att använda som val för detta fält, enumerationstyp, eller en callable som returnerar en sådan iterabel. Detta argument accepterar samma format som argumentet choices till ett modellfält. Se modellfältets referensdokumentation om choices för mer information. Om argumentet är en callable utvärderas det varje gång fältets form initieras, förutom under rendering. Standardvärdet är en tom lista.

\n
\n\n\n
\n\n
\n
\n

DateFieldLink to this heading#

\n
\n
\nclass DateField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: DateInput

    • \n

  • Tomt värde: None

    • \n

  • Normaliseras till: Ett Python-objekt av typen datetime.date.

    • \n

  • Validerar att det angivna värdet är antingen ett datetime.date, datetime.datetime eller en sträng formaterad i ett visst datumformat.

    • \n

  • Nycklar för felmeddelanden: ”Obligatoriskt”, ”Ogiltigt

    • \n
\n

Tar emot ett valfritt argument:

\n
\n
\ninput_formatsLink to this definition#
\n

En iterabel av format som används för att försöka konvertera en sträng till ett giltigt datetime.date-objekt.

\n
\n\n

Om inget input_formats-argument anges hämtas standardinmatningsformaten från det aktiva lokala formatet DATE_INPUT_FORMATS, eller från DATE_INPUT_FORMATS om lokalisering är inaktiverad. Se även format localization.

\n
\n\n
\n
\n

DatumTimeFieldLink to this heading#

\n
\n
\nclass DateTimeField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: DateTimeInput

    • \n

  • Tomt värde: None

    • \n

  • Normaliseras till: Ett Python-objekt av typen datetime.datetime.

    • \n

  • Validerar att det angivna värdet är antingen en datetime.datetime, datetime.date eller en sträng formaterad i ett visst datetime-format.

    • \n

  • Nycklar för felmeddelanden: ”Obligatoriskt”, ”Ogiltigt

    • \n
\n

Tar emot ett valfritt argument:

\n
\n
\ninput_formatsLink to this definition#
\n

En iterabel av format som används för att försöka konvertera en sträng till ett giltigt datetime.datetime-objekt, utöver ISO 8601-format.

\n
\n\n

Fältet accepterar alltid strängar i ISO 8601-formaterade datum eller liknande som känns igen av parse_datetime(). Några exempel är:

\n
    \n

  • '2006-10-25 14:30:59'

    • \n

  • '2006-10-25T14:30:59'

    • \n

  • '2006-10-25 14:30'

    • \n

  • '2006-10-25T14:30'

    • \n

  • '2006-10-25T14:30Z'

    • \n

  • '2006-10-25T14:30+02:00'

    • \n

  • '2006-10-25'

    • \n
\n

Om inget input_formats-argument anges hämtas standardinmatningsformaten från det aktiva lokala formatet DATETIME_INPUT_FORMATS och DATE_INPUT_FORMATS-nycklar, eller från DATETIME_INPUT_FORMATS och DATE_INPUT_FORMATS om lokalisering är inaktiverad. Se även format localization.

\n
\n\n
\n
\n

DecimalFieldLink to this heading#

\n
\n
\nclass DecimalField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: NumberInput när Field.localize är False, annars TextInput.

    • \n

  • Tomt värde: None

    • \n

  • Normaliseras till: En Python decimal.

    • \n

  • Validerar att det angivna värdet är en decimal. Använder MaxValueValidator och MinValueValidator om max_value och min_value anges. Använder StepValueValidator om step_size anges. Ledande och efterföljande blanksteg ignoreras.

    • \n

  • Nycklar för felmeddelanden: required, invalid, max_value, min_value, max_digits, max_decimal_places, max_whole_digits, step_size.

    • \n
\n

Felmeddelandena max_value och min_value kan innehålla %(limit_value)s, som kommer att ersättas med lämplig gräns. På samma sätt kan felmeddelandena max_digits, max_decimal_places och max_whole_digits innehålla %(max)s.

\n

Tar emot fem valfria argument:

\n
\n
\nmax_valueLink to this definition#
\n
\n\n
\n
\nmin_valueLink to this definition#
\n

Dessa styr det intervall av värden som tillåts i fältet och bör anges som decimal.decimal-värden.

\n
\n\n
\n
\nmax_digitsLink to this definition#
\n

Det maximala antalet siffror (de före decimaltecknet plus de efter decimaltecknet, med inledande nollor borttagna) som tillåts i värdet.

\n
\n\n
\n
\ndecimal_placesLink to this definition#
\n

Det maximala antalet decimaler som tillåts.

\n
\n\n
\n
\nstep_sizeLink to this definition#
\n

Begränsa giltiga indata till en integrerad multipel av step_size. Om min_value också anges läggs det till som en förskjutning för att avgöra om stegstorleken matchar.

\n
\n\n
\n\n
\n
\n

DurationFieldLink to this heading#

\n
\n
\nclass DurationField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: TextInput

    • \n

  • Tomt värde: None

    • \n

  • Normaliseras till: En Python timedelta.

    • \n

  • Validerar att det angivna värdet är en sträng som kan konverteras till en timedelta. Värdet måste ligga mellan datetime.timedelta.min och datetime.timedelta.max.

    • \n

  • Nycklar för felmeddelanden: krävs, ogiltigt, överflöde.

    • \n
\n

Accepterar alla format som förstås av parse_duration().

\n
\n\n
\n
\n

EmailFieldLink to this heading#

\n
\n
\nclass EmailField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: EmailInput

    • \n

  • Tomt värde: Vad du än har angett som empty_value.

    • \n

  • Normaliseras till: En sträng.

    • \n

  • Använder EmailValidator för att validera att det angivna värdet är en giltig e-postadress, med hjälp av ett måttligt komplext reguljärt uttryck.

    • \n

  • Nycklar för felmeddelanden: ”Obligatoriskt”, ”Ogiltigt

    • \n
\n

Har de valfria argumenten max_length, min_length och empty_value som fungerar precis som de gör för CharField. Argumentet max_length är som standard 320 (se RFC 3696 Section 3).

\n
\n\n
\n
\n

FileFieldLink to this heading#

\n
\n
\nclass FileField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: ClearableFileInput

    • \n

  • Tomt värde: None

    • \n

  • Normaliseras till: Ett UploadedFile-objekt som sammanfattar filinnehållet och filnamnet i ett enda objekt.

    • \n

  • Kan validera att icke-tom filinformation har bundits till formuläret.

    • \n

  • Nycklar för felmeddelanden: krävs, ogiltigt, `` saknas``, tomt, max_längd

    • \n
\n

Har de valfria argumenten för validering: max_length och allow_empty_file. Om de anges säkerställer de att filnamnet har högst den angivna längden och att valideringen lyckas även om filinnehållet är tomt.

\n

Mer information om objektet UploadedFile finns i dokumentation om filuppladdningar.

\n

När du använder en FileField i ett formulär måste du också komma ihåg att binda filinformationen till formuläret.

\n

Felet max_length hänvisar till filnamnets längd. I felmeddelandet för den nyckeln kommer %(max)d att ersättas med den maximala filnamnslängden och %(length)d kommer att ersättas med den aktuella filnamnslängden.

\n
\n\n
\n
\n

FilePathFieldLink to this heading#

\n
\n
\nclass FilePathField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: Select

    • \n

  • Tomt värde: '' (en tom sträng)

    • \n

  • Normaliseras till: En sträng.

    • \n

  • Kontrollerar att det valda alternativet finns i listan med alternativ.

    • \n

  • Nycklar för felmeddelanden: krävs, ogiltigt_val

    • \n
\n

Fältet gör det möjligt att välja bland filer i en viss katalog. Det tar fem extra argument; endast path är obligatoriskt:

\n
\n
\npathLink to this definition#
\n

Den absoluta sökvägen till den katalog vars innehåll du vill lista. Denna katalog måste existera.

\n
\n\n
\n
\nrecursiveLink to this definition#
\n

Om False (standard) kommer endast det direkta innehållet i path att erbjudas som val. Om True, kommer katalogen att vara rekursivt nedåtgående och alla nedåtgående kommer att listas som val.

\n
\n\n
\n
\nmatchLink to this definition#
\n

Ett mönster för ett reguljärt uttryck; endast filer med namn som matchar detta uttryck kommer att tillåtas som val.

\n
\n\n
\n
\nallow_filesLink to this definition#
\n

Valfritt. Antingen True eller False. Standard är True. Anger om filer på den angivna platsen ska inkluderas. Antingen detta eller allow_folders måste vara True.

\n
\n\n
\n
\nallow_foldersLink to this definition#
\n

Valfritt. Antingen True eller False. Standard är False. Anger om mappar på den angivna platsen ska inkluderas. Antingen detta eller allow_files måste vara True.

\n
\n\n
\n\n
\n
\n

FloatFieldLink to this heading#

\n
\n
\nclass FloatField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: NumberInput när Field.localize är False, annars TextInput.

    • \n

  • Tomt värde: None

    • \n

  • Normaliseras till: En Python-flottör.

    • \n

  • Validerar att det angivna värdet är en float. Använder MaxValueValidator och MinValueValidator om max_value och min_value anges. Använder StepValueValidator om step_size anges. Ledande och efterföljande blanktecken är tillåtna, som i Pythons funktion float().

    • \n

  • Nycklar för felmeddelanden: required, invalid, max_value, min_value, step_size.

    • \n
\n

Tar emot tre valfria argument:

\n
\n
\nmax_valueLink to this definition#
\n
\n\n
\n
\nmin_valueLink to this definition#
\n

Dessa styr det värdeintervall som tillåts i fältet.

\n
\n\n
\n
\nstep_sizeLink to this definition#
\n

Begränsa giltiga indata till en integrerad multipel av step_size. Om min_value också anges läggs det till som en förskjutning för att avgöra om stegstorleken matchar.

\n
\n\n
\n\n
\n
\n

GenericIPAddressFieldLink to this heading#

\n
\n
\nclass GenericIPAddressField(**kwargs)Link to this definition#
\n

Ett fält som innehåller antingen en IPv4- eller en IPv6-adress.

\n
    \n

  • Standardwidget: TextInput

    • \n

  • Tomt värde: '' (en tom sträng)

    • \n

  • Normaliseras till: En sträng. IPv6-adresser normaliseras enligt beskrivningen nedan.

    • \n

  • Kontrollerar att det angivna värdet är en giltig IP-adress.

    • \n

  • Nycklar för felmeddelanden: required, invalid, max_length

    • \n
\n

Normaliseringen av IPv6-adresser följer RFC 4291 Section 2.2 avsnitt 2.2, inklusive användning av det IPv4-format som föreslås i punkt 3 i det avsnittet, som ::ffff:192.0.2.0. Till exempel: skulle 2001:0::0:01 normaliseras till 2001::1, och ::ffff:0a0a:0a0a till ::ffff:10.10.10.10. Alla tecken konverteras till gemener.

\n

Tar emot tre valfria argument:

\n
\n
\nprotocolLink to this definition#
\n

Begränsar giltiga indata till det angivna protokollet. Accepterade värden är both (standard), IPv4 eller IPv6. Matchningen är okänslig för skiftlägesanalys.

\n
\n\n
\n
\nunpack_ipv4Link to this definition#
\n

Packar upp IPv4-mappade adresser som ::ffff:192.0.2.1. Om detta alternativ är aktiverat kommer den adressen att packas upp till 192.0.2.1. Standard är inaktiverat. Kan endast användas när protocol är inställt på 'both'.

\n
\n\n
\n
\nmax_lengthLink to this definition#
\n

Standardvärdet är 39 och fungerar på samma sätt som för CharField.

\n
\n\n\n
\n\n
\n
\n

ImageFieldLink to this heading#

\n
\n
\nclass ImageField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: ClearableFileInput

    • \n

  • Tomt värde: None

    • \n

  • Normaliseras till: Ett UploadedFile-objekt som sammanfattar filinnehållet och filnamnet i ett enda objekt.

    • \n

  • Validerar att fildata har bundits till formuläret. Använder även FileExtensionValidator för att validera att filändelsen stöds av Pillow.

    • \n

  • Nycklar för felmeddelanden: krävs, ogiltig, `` saknas``, tomt, ogiltig_bild

    • \n
\n

För att använda en ImageField krävs att pillow är installerat med stöd för de bildformat du använder. Om du stöter på ett corrupt image-fel när du laddar upp en bild, betyder det vanligtvis att Pillow inte förstår dess format. För att åtgärda detta installerar du lämpligt bibliotek och installerar om Pillow.

\n

När du använder en ImageField på ett formulär måste du också komma ihåg att binda filinformationen till formuläret.

\n

Efter att fältet har rensats och validerats kommer objektet UploadedFile att ha ett ytterligare image-attribut som innehåller Pillow Image-instansen som används för att kontrollera om filen var en giltig bild. Pillow stänger den underliggande filbeskrivaren efter att ha verifierat en bild, så medan attribut för icke-bilddata, t.ex. format, höjd och bredd, är tillgängliga, kan metoder som får åtkomst till underliggande bilddata, t.ex. getdata() eller getpixel(), inte användas utan att öppna filen igen. Ett exempel:

\n
Python console
>>> from PIL import Image\n>>> from django import forms\n>>> from django.core.files.uploadedfile import SimpleUploadedFile\n>>> class ImageForm(forms.Form):\n...     img = forms.ImageField()\n...\n>>> file_data = {"img": SimpleUploadedFile("test.png", b"file data")}\n>>> form = ImageForm({}, file_data)\n# Pillow closes the underlying file descriptor.\n>>> form.is_valid()\nTrue\n>>> image_field = form.cleaned_data["img"]\n>>> image_field.image\n<PIL.PngImagePlugin.PngImageFile image mode=RGBA size=191x287 at 0x7F5985045C18>\n>>> image_field.image.width\n191\n>>> image_field.image.height\n287\n>>> image_field.image.format\n'PNG'\n>>> image_field.image.getdata()\n# Raises AttributeError: 'NoneType' object has no attribute 'seek'.\n>>> image = Image.open(image_field)\n>>> image.getdata()\n<ImagingCore object at 0x7f5984f874b0>\n
\n

Dessutom kommer UploadedFile.content_type att uppdateras med bildens innehållstyp om Pillow kan bestämma den, annars kommer den att sättas till None.

\n
\n\n
\n
\n

IntegerFieldLink to this heading#

\n
\n
\nclass IntegerField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: NumberInput när Field.localize är False, annars TextInput.

    • \n

  • Tomt värde: None

    • \n

  • Normaliseras till: Ett heltal i Python.

    • \n

  • Validerar att det givna värdet är ett heltal. Använder MaxValueValidator och MinValueValidator om max_value och min_value anges. Använder StepValueValidator om step_size anges. Ledande och efterföljande blanktecken är tillåtna, som i Pythons funktion int().

    • \n

  • Nycklar för felmeddelanden: required, invalid, max_value, min_value, step_size

    • \n
\n

Felmeddelandena max_value, min_value och step_size kan innehålla %(limit_value)s, som ersätts med lämplig gräns.

\n

Tar emot tre valfria argument för validering:

\n
\n
\nmax_valueLink to this definition#
\n
\n\n
\n
\nmin_valueLink to this definition#
\n

Dessa styr det värdeintervall som tillåts i fältet.

\n
\n\n
\n
\nstep_sizeLink to this definition#
\n

Begränsa giltiga indata till en integrerad multipel av step_size. Om min_value också anges läggs det till som en förskjutning för att avgöra om stegstorleken matchar.

\n
\n\n
\n\n
\n
\n

JSONFieldLink to this heading#

\n
\n
\nclass JSONField(encoder=None, decoder=None, **kwargs)Link to this definition#
\n

Ett fält som tar emot JSON-kodade data för en JSONField.

\n
    \n

  • Standardwidget: Textarea

    • \n

  • Tomt värde: None

    • \n

  • Normaliseras till: En Python-representation av JSON-värdet (vanligtvis som en dict, list eller None), beroende på JSONField.decoder.

    • \n

  • Validerar att det angivna värdet är en giltig JSON.

    • \n

  • Nycklar för felmeddelanden: ”Obligatoriskt”, ”Ogiltigt

    • \n
\n

Tar två valfria argument:

\n
\n
\nencoderLink to this definition#
\n

En json.JSONEncoder-underklass för att serialisera datatyper som inte stöds av standard JSON serializer (t.ex. datetime.datetime eller UUID). Du kan till exempel använda klassen DjangoJSONEncoder.

\n

Standardvärdet är json.JSONEncoder.

\n
\n\n
\n
\ndecoderLink to this definition#
\n

En json.JSONDecoder-underklass för att deserialisera indata. Din deserialisering kan behöva ta hänsyn till det faktum att du inte kan vara säker på indatatypen. Till exempel: riskerar du att returnera en datetime som faktiskt var en sträng som bara råkade vara i samma format som valts för datetime.

\n

Dekodaren kan användas för att validera indata. Om json.JSONDecodeError uppstår under deserialiseringen, kommer ett ValidationError att uppstå.

\n

Standardvärdet är json.JSONDecoder.

\n
\n\n\n\n
\n\n
\n
\n

MultipleChoiceFieldLink to this heading#

\n
\n
\nclass MultipleChoiceField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: SelectMultiple

    • \n

  • Tomt värde: [] (en tom lista)

    • \n

  • Normaliserar till: En lista med strängar.

    • \n

  • Validerar att alla värden i den angivna listan med värden finns i listan med val.

    • \n

  • Nycklar för felmeddelanden: required, invalid_choice, invalid_list

    • \n
\n

Felmeddelandet invalid_choice kan innehålla %(value)s, som kommer att ersättas med det valda alternativet.

\n

Tar ett extra obligatoriskt argument, choices, som för ChoiceField.

\n
\n\n
\n
\n

NullBooleanFieldLink to this heading#

\n
\n
\nclass NullBooleanField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: NullBooleanSelect

    • \n

  • Tomt värde: None

    • \n

  • Normaliseras till: Ett Python-värde av typen True, False eller None.

    • \n

  • Validerar ingenting (d.v.s. det ger aldrig upphov till ett ValidationError).

    • \n
\n

NullBooleanField kan användas med widgetar som Select eller RadioSelect genom att tillhandahålla widgeten choices:

\n
Code
NullBooleanField(\n    widget=Select(\n        choices=[\n            ("", "Unknown"),\n            (True, "Yes"),\n            (False, "No"),\n        ]\n    )\n)\n
\n
\n\n
\n
\n

RegexFieldLink to this heading#

\n
\n
\nclass RegexField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: TextInput

    • \n

  • Tomt värde: Vad du än har angett som empty_value.

    • \n

  • Normaliseras till: En sträng.

    • \n

  • Använder RegexValidator för att validera att det angivna värdet matchar ett visst reguljärt uttryck.

    • \n

  • Nycklar för felmeddelanden: ”Obligatoriskt”, ”Ogiltigt

    • \n
\n

Kräver ett argument:

\n
\n
\nregexLink to this definition#
\n

Ett reguljärt uttryck som anges antingen som en sträng eller som ett kompilerat objekt för reguljära uttryck.

\n
\n\n

Tar också max_length, min_length, strip och empty_value som fungerar precis som de gör för CharField.

\n
\n
\nstripLink to this definition#
\n

Standardvärdet är False. Om aktiverat kommer stripping att tillämpas före regex-valideringen.

\n
\n\n
\n\n
\n
\n

SlugFieldLink to this heading#

\n
\n
\nclass SlugField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: TextInput

    • \n

  • Tomt värde: Vad du än har angett som empty_value.

    • \n

  • Normaliseras till: En sträng.

    • \n

  • Använder validate_slug eller validate_unicode_slug för att validera att det angivna värdet endast innehåller bokstäver, siffror, understreck och bindestreck.

    • \n

  • Felmeddelanden: krävs, ogiltigt

    • \n
\n

Detta fält är avsett att användas för att representera en modell SlugField i formulär.

\n

Tar emot två valfria parametrar:

\n
\n
\nallow_unicodeLink to this definition#
\n

En boolean som instruerar fältet att acceptera Unicode-bokstäver utöver ASCII-bokstäver. Standardvärdet är False.

\n
\n\n
\n
\nempty_valueLink to this definition#
\n

Det värde som ska användas för att representera ”tom”. Standardvärdet är en tom sträng.

\n
\n\n
\n\n
\n
\n

TimeFieldLink to this heading#

\n
\n
\nclass TimeField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: TimeInput

    • \n

  • Tomt värde: None

    • \n

  • Normaliseras till: Ett Python-objekt av typen datetime.time.

    • \n

  • Validerar att det angivna värdet är antingen en datetime.time eller en sträng formaterad i ett visst tidsformat.

    • \n

  • Nycklar för felmeddelanden: ”Obligatoriskt”, ”Ogiltigt

    • \n
\n

Tar emot ett valfritt argument:

\n
\n
\ninput_formatsLink to this definition#
\n

En iterabel av format som används för att försöka konvertera en sträng till ett giltigt datetime.time-objekt.

\n
\n\n

Om inget input_formats-argument anges hämtas standardinmatningsformaten från det aktiva lokala formatet TIME_INPUT_FORMATS, eller från TIME_INPUT_FORMATS om lokalisering är inaktiverad. Se även format localization.

\n
\n\n
\n
\n

TypedChoiceFieldLink to this heading#

\n
\n
\nclass TypedChoiceField(**kwargs)Link to this definition#
\n

Precis som en ChoiceField, men TypedChoiceField tar två extra argument, coerce och empty_value.

\n
    \n

  • Standardwidget: Select

    • \n

  • Tomt värde: Vad du än har angett som empty_value.

    • \n

  • Normaliseras till: Ett värde av den typ som anges av argumentet coerce.

    • \n

  • Validerar att det angivna värdet finns i listan med val och kan tvingas fram.

    • \n

  • Nycklar för felmeddelanden: krävs, ogiltigt_val

    • \n
\n

Tar extra argument:

\n
\n
\ncoerceLink to this definition#
\n

En funktion som tar ett argument och returnerar ett tvingat värde. Exempel är de inbyggda typerna int, float, bool och andra typer. Standardvärdet är en identitetsfunktion. Observera att tvingande sker efter validering av indata, så det är möjligt att tvinga till ett värde som inte finns i choices.

\n
\n\n
\n
\nempty_valueLink to this definition#
\n

Det värde som ska användas för att representera ”tom” Standardvärdet är den tomma strängen; None är ett annat vanligt val här. Observera att det här värdet inte kommer att tvingas fram av den funktion som anges i argumentet coerce, så välj det i enlighet med detta.

\n
\n\n
\n\n
\n
\n

Typ av flervalsfältLink to this heading#

\n
\n
\nclass TypedMultipleChoiceField(**kwargs)Link to this definition#
\n

Precis som en MultipleChoiceField, förutom att TypedMultipleChoiceField tar två extra argument, coerce och empty_value.

\n
    \n

  • Standardwidget: SelectMultiple

    • \n

  • Tomt värde: Vad du än har angett som empty_value

    • \n

  • Normaliseras till: En lista med värden av den typ som anges i argumentet coerce.

    • \n

  • Validerar att de angivna värdena finns i listan med val och kan tvingas.

    • \n

  • Nycklar för felmeddelanden: krävs, ogiltigt_val

    • \n
\n

Felmeddelandet invalid_choice kan innehålla %(value)s, som kommer att ersättas med det valda alternativet.

\n

Tar två extra argument, coerce och empty_value, som för TypedChoiceField.

\n
\n\n
\n
\n

URL-fältLink to this heading#

\n
\n
\nclass URLField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: URLInput

    • \n

  • Tomt värde: Vad du än har angett som empty_value.

    • \n

  • Normaliseras till: En sträng.

    • \n

  • Använder URLValidator för att validera att det angivna värdet är en giltig URL.

    • \n

  • Nycklar för felmeddelanden: ”Obligatoriskt”, ”Ogiltigt

    • \n
\n

Har de valfria argumenten max_length, min_length, empty_value som fungerar precis som de gör för CharField, och ytterligare ett argument:

\n
\n
\nassume_schemeLink to this definition#
\n

Det schema som antas för webbadresser som inte har något schema. Standardvärdet är "http". Till exempel:, om assume_scheme är "https" och det angivna värdet är "example.com", kommer det normaliserade värdet att vara "https://example.com".

\n
\n\n\n
\n\n
\n
\n

UUIDFieldLink to this heading#

\n
\n
\nclass UUIDField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: TextInput

    • \n

  • Tomt värde: None

    • \n

  • Normaliseras till: Ett UUID-objekt.

    • \n

  • Nycklar för felmeddelanden: ”Obligatoriskt”, ”Ogiltigt

    • \n
\n

Detta fält accepterar alla strängformat som accepteras som hex-argument till UUID-konstruktören.

\n
\n\n
\n
\n
\n

Något komplexa inbyggda Field-klasserLink to this heading#

\n
\n

ComboFieldLink to this heading#

\n
\n
\nclass ComboField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: TextInput

    • \n

  • Tomt värde: '' (en tom sträng)

    • \n

  • Normaliseras till: En sträng.

    • \n

  • Validerar det angivna värdet mot vart och ett av de fält som angetts som argument till ComboField.

    • \n

  • Nycklar för felmeddelanden: ”Obligatoriskt”, ”Ogiltigt

    • \n
\n

Kräver ett extra argument:

\n
\n
\nfieldsLink to this definition#
\n

Lista över fält som ska användas för att validera fältets värde (i den ordning de anges).

\n
Python console
>>> from django.forms import ComboField\n>>> f = ComboField(fields=[CharField(max_length=20), EmailField()])\n>>> f.clean("test@example.com")\n'test@example.com'\n>>> f.clean("longemailaddress@example.com")\nTraceback (most recent call last):\n...\nValidationError: ['Ensure this value has at most 20 characters (it has 28).']\n
\n
\n\n
\n\n
\n
\n

MultiValueFieldLink to this heading#

\n
\n
\nclass MultiValueField(fields=(), **kwargs)Link to this definition#
\n
    \n

  • Standardwidget: TextInput

    • \n

  • Tomt värde: '' (en tom sträng)

    • \n

  • Normaliserar till: den typ som returneras av compress-metoden i underklassen.

    • \n

  • Validerar det angivna värdet mot vart och ett av de fält som angetts som argument till MultiValueField.

    • \n

  • Nycklar för felmeddelanden: ”Obligatoriskt”, ”Ogiltigt”, ”Ofullständigt

    • \n
\n

Sammanställer logiken i flera fält som tillsammans ger ett enda värde.

\n

Detta fält är abstrakt och måste underklassas. Till skillnad från envärdesfälten får underklasser av MultiValueField inte implementera clean() utan istället - implementera compress().

\n

Kräver ett extra argument:

\n
\n
\nfieldsLink to this definition#
\n

En tupel av fält vars värden rensas och därefter kombineras till ett enda värde. Varje värde i fältet rensas av motsvarande fält i fields – det första värdet rensas av det första fältet, det andra värdet rensas av det andra fältet, osv. När alla fält har rensats kombineras listan över rensade värden till ett enda värde med compress().

\n
\n\n

Tar också några valfria argument:

\n
\n
\nrequire_all_fieldsLink to this definition#
\n

Standardvärdet är True, i vilket fall ett required valideringsfel kommer att uppstå om inget värde anges för något fält.

\n

När attributet Field.required är satt till False kan det sättas till False för enskilda fält för att göra dem valfria. Om inget värde anges för ett obligatoriskt fält kommer valideringsfelet incomplete att uppstå.

\n

Ett standardfelmeddelande incomplete kan definieras för underklassen MultiValueField, eller så kan olika meddelanden definieras för varje enskilt fält. Till exempel:

\n
Code
from django.core.validators import RegexValidator\n\n\nclass PhoneField(MultiValueField):\n    def __init__(self, **kwargs):\n        # Define one message for all fields.\n        error_messages = {\n            "incomplete": "Enter a country calling code and a phone number.",\n        }\n        # Or define a different message for each field.\n        fields = (\n            CharField(\n                error_messages={"incomplete": "Enter a country calling code."},\n                validators=[\n                    RegexValidator(r"^[0-9]+$", "Enter a valid country calling code."),\n                ],\n            ),\n            CharField(\n                error_messages={"incomplete": "Enter a phone number."},\n                validators=[RegexValidator(r"^[0-9]+$", "Enter a valid phone number.")],\n            ),\n            CharField(\n                validators=[RegexValidator(r"^[0-9]+$", "Enter a valid extension.")],\n                required=False,\n            ),\n        )\n        super().__init__(\n            error_messages=error_messages,\n            fields=fields,\n            require_all_fields=False,\n            **kwargs\n        )\n
\n
\n\n
\n
\nwidgetLink to this definition#
\n

Måste vara en underklass till django.forms.MultiWidget. Standardvärdet är TextInput, vilket förmodligen inte är särskilt användbart i det här fallet.

\n
\n\n
\n
\ncompress(data_list)Link to this definition#
\n

Tar en lista med giltiga värden och returnerar en ”komprimerad” version av dessa värden - i ett enda värde. Exempelvis är SplitDateTimeField en underklass som kombinerar ett tidsfält och ett datumfält till ett datetime-objekt.

\n

Denna metod måste implementeras i underklasserna.

\n
\n\n
\n\n
\n
\n

SplitDateTimeFieldLink to this heading#

\n
\n
\nclass SplitDateTimeField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: SplitDateTimeWidget

    • \n

  • Tomt värde: None

    • \n

  • Normaliseras till: Ett Python-objekt av typen datetime.datetime.

    • \n

  • Validerar att det angivna värdet är en datetime.datetime eller en sträng formaterad i ett visst datetime-format.

    • \n

  • Nycklar för felmeddelanden: required, invalid, invalid_date, invalid_time

    • \n
\n

Tar två valfria argument:

\n
\n
\ninput_date_formatsLink to this definition#
\n

En lista över format som används för att försöka konvertera en sträng till ett giltigt datetime.date-objekt.

\n
\n\n

Om inget input_date_formats-argument anges används standardformaten för inmatning för DateField.

\n
\n
\ninput_time_formatsLink to this definition#
\n

En lista över format som används för att försöka konvertera en sträng till ett giltigt datetime.time-objekt.

\n
\n\n

Om inget input_time_formats-argument anges används standardformaten för inmatning för TimeField.

\n
\n\n
\n
\n
\n

Fält som hanterar relationerLink to this heading#

\n

Två fält finns tillgängliga för att representera relationer mellan modeller: ModelChoiceField och ModelMultipleChoiceField. Båda dessa fält kräver en enda parameter, queryset, som används för att skapa valmöjligheterna för fältet. Vid validering av formuläret kommer dessa fält att placera antingen ett modellobjekt (i fallet ModelChoiceField) eller flera modellobjekt (i fallet ModelMultipleChoiceField) i formulärets cleaned_data-ordbok.

\n

För mer komplexa användningar kan du ange queryset=None när du deklarerar formulärfältet och sedan fylla i queryset i formulärets __init__()-metod:

\n
Code
class FooMultipleChoiceForm(forms.Form):\n    foo_select = forms.ModelMultipleChoiceField(queryset=None)\n\n    def __init__(self, *args, **kwargs):\n        super().__init__(*args, **kwargs)\n        self.fields["foo_select"].queryset = ...\n
\n

Både ModelChoiceField och ModelMultipleChoiceField har ett iterator attribut som specificerar den klass som används för att iterera över frågeuppsättningen när val genereras. Se Iteration av relationsval för detaljer.

\n
\n

ModellValFieldLink to this heading#

\n
\n
\nclass ModelChoiceField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: Select

    • \n

  • Tomt värde: None

    • \n

  • Normaliseras till: En modellinstans.

    • \n

  • Validerar att det angivna id:et finns i frågeuppsättningen.

    • \n

  • Nycklar för felmeddelanden: krävs, ogiltigt_val

    • \n
\n

Felmeddelandet invalid_choice kan innehålla %(value)s, som kommer att ersättas med det valda alternativet.

\n

Gör det möjligt att välja ett enda modellobjekt, lämpligt för att representera en främmande nyckel. Observera att standardwidgeten för ModelChoiceField blir opraktisk när antalet poster ökar. Du bör undvika att använda den för mer än 100 poster.

\n

Ett enda argument krävs:

\n
\n
\nquerysetLink to this definition#
\n

En QuerySet av modellobjekt från vilka valmöjligheterna för fältet härleds och som används för att validera användarens val. Den utvärderas när formuläret renderas.

\n
\n\n

ModelChoiceField tar också flera valfria argument:

\n
\n
\nempty_labelLink to this definition#
\n

Som standard kommer widgeten <select> som används av ModelChoiceField att ha ett tomt val längst upp i listan. Du kan ändra texten på denna etikett (som är "---------" som standard) med attributet empty_label, eller du kan inaktivera den tomma etiketten helt genom att ställa in empty_label till None:

\n
Code
# A custom empty label\nfield1 = forms.ModelChoiceField(queryset=..., empty_label="(Nothing)")\n\n# No empty label\nfield2 = forms.ModelChoiceField(queryset=..., empty_label=None)\n
\n

Observera att inget tomt val skapas (oavsett värdet på empty_label) om en ModelChoiceField krävs och har ett standardinitialvärde, eller om en widget är inställd på RadioSelect och argumentet blank är False.

\n
\n\n
\n
\nto_field_nameLink to this definition#
\n

Detta valfria argument används för att ange det fält som ska användas som värde för valen i fältets widget. Se till att det är ett unikt fält för modellen, annars kan det valda värdet matcha mer än ett objekt. Som standard är det inställt på None, i vilket fall primärnyckeln för varje objekt kommer att användas. Till exempel:

\n
Code
# No custom to_field_name\nfield1 = forms.ModelChoiceField(queryset=...)\n
\n

skulle ge:

\n
Html
<select id="id_field1" name="field1">\n<option value="obj1.pk">Object1</option>\n<option value="obj2.pk">Object2</option>\n...\n</select>\n
\n

och:

\n
Code
# to_field_name provided\nfield2 = forms.ModelChoiceField(queryset=..., to_field_name="name")\n
\n

skulle ge:

\n
Html
<select id="id_field2" name="field2">\n<option value="obj1.name">Object1</option>\n<option value="obj2.name">Object2</option>\n...\n</select>\n
\n
\n\n
\n
\nblankLink to this definition#
\n

När du använder widgeten RadioSelect, avgör detta valfria booleska argument om ett tomt val skapas. Som standard är blank False, i vilket fall inget tomt val skapas.

\n
\n\n

ModelChoiceField har också attributet:

\n
\n
\niteratorLink to this definition#
\n

Den iteratorklass som används för att generera fältval från queryset. Som standard används ModelChoiceIterator.

\n
\n\n

Metoden __str__() i modellen kommer att anropas för att generera strängrepresentationer av objekten för användning i fältets val. För att tillhandahålla anpassade representationer, subklassa ModelChoiceField och åsidosätt label_from_instance. Denna metod tar emot ett modellobjekt och ska returnera en sträng som är lämplig för att representera det. Till exempel:

\n
Code
from django.forms import ModelChoiceField\n\n\nclass MyModelChoiceField(ModelChoiceField):\n    def label_from_instance(self, obj):\n        return "My Object #%i" % obj.id\n
\n
\n\n
\n
\n

ModellMultipleChoiceFieldLink to this heading#

\n
\n
\nclass ModelMultipleChoiceField(**kwargs)Link to this definition#
\n
    \n

  • Standardwidget: SelectMultiple

    • \n

  • Tomt värde: En tom QuerySet (self.queryset.none())

    • \n

  • Normaliseras till: En QuerySet av modellinstanser.

    • \n

  • Validerar att varje id i den angivna listan med värden finns i queryset.

    • \n

  • Nycklar för felmeddelanden: required, invalid_list, invalid_choice, invalid_pk_value

    • \n
\n

Meddelandet invalid_choice kan innehålla %(value)s och meddelandet invalid_pk_value kan innehålla %(pk)s, som kommer att ersättas med lämpliga värden.

\n

Tillåter val av ett eller flera modellobjekt, lämpligt för att representera en många-till-många-relation. Precis som med ModelChoiceField kan du använda label_from_instance för att anpassa objektrepresentationerna.

\n

Ett enda argument krävs:

\n
\n
\nquerysetLink to this definition#
\n

Samma som ModelChoiceField.queryset.

\n
\n\n

Tar emot ett valfritt argument:

\n
\n
\nto_field_nameLink to this definition#
\n

Samma som ModelChoiceField.to_field_name.

\n
\n\n

ModelMultipleChoiceField har också attributet:

\n
\n
\niteratorLink to this definition#
\n

Samma som ModelChoiceField.iterator.

\n
\n\n
\n\n
\n
\n

Iteration av relationsvalLink to this heading#

\n

Som standard använder ModelChoiceField och ModelMultipleChoiceField ModelChoiceIterator för att generera fältets choices.

\n

Vid iteration ger ModelChoiceIterator 2-tupelval som innehåller ModelChoiceIteratorValue-instanser som det första value-elementet i varje val. ModelChoiceIteratorValue omsluter valvärdet samtidigt som det bibehåller en referens till källmodellinstansen som kan användas i anpassade widgetimplementeringar, till exempel för att lägga till data-* attribut till <option> element.

\n

Tänk till exempel på följande modeller:

\n
Code
from django.db import models\n\n\nclass Topping(models.Model):\n    name = models.CharField(max_length=100)\n    price = models.DecimalField(decimal_places=2, max_digits=6)\n\n    def __str__(self):\n        return self.name\n\n\nclass Pizza(models.Model):\n    topping = models.ForeignKey(Topping, on_delete=models.CASCADE)\n
\n

Du kan använda en Select widgetunderklass för att inkludera värdet av Topping.price som HTML-attributet data-price för varje <option> element:

\n
Code
from django import forms\n\n\nclass ToppingSelect(forms.Select):\n    def create_option(\n        self, name, value, label, selected, index, subindex=None, attrs=None\n    ):\n        option = super().create_option(\n            name, value, label, selected, index, subindex, attrs\n        )\n        if value:\n            option["attrs"]["data-price"] = value.instance.price\n        return option\n\n\nclass PizzaForm(forms.ModelForm):\n    class Meta:\n        model = Pizza\n        fields = ["topping"]\n        widgets = {"topping": ToppingSelect}\n
\n

Detta kommer att göra Pizza.topping-valet som:

\n
Html
<select id="id_topping" name="topping" required>\n<option value="" selected>---------</option>\n<option value="1" data-price="1.50">mushrooms</option>\n<option value="2" data-price="1.25">onions</option>\n<option value="3" data-price="1.75">peppers</option>\n<option value="4" data-price="2.00">pineapple</option>\n</select>\n
\n

För mer avancerad användning kan du subklassa ModelChoiceIterator för att anpassa de 2-tupelval som erhålls.

\n
\n

ModelChoiceIteratorLink to this heading#

\n
\n
\nclass ModelChoiceIterator(field)Link to this definition#
\n

Standardklassen som tilldelas attributet iterator i ModelChoiceField och ModelMultipleChoiceField. En iterator som ger 2-tupelval från frågeuppsättningen.

\n

Ett enda argument krävs:

\n
\n
\nfieldLink to this definition#
\n

Instansen av ModelChoiceField eller ModelMultipleChoiceField för att iterera och ge val.

\n
\n\n

ModelChoiceIterator har följande metod:

\n
\n
\n__iter__()Link to this definition#
\n

Ger 2-tupelval, i formatet (value, label) som används av ChoiceField.choices. Det första value-elementet är en ModelChoiceIteratorValue-instans.

\n
\n\n
\n\n
\n
\n

ModelChoiceIteratorValueLink to this heading#

\n
\n
\nclass ModelChoiceIteratorValue(value, instance)Link to this definition#
\n

Två argument krävs:

\n
\n
\nvalueLink to this definition#
\n

Valets värde. Detta värde används för att återge attributet value i ett HTML-element <option>.

\n
\n\n
\n
\ninstanceLink to this definition#
\n

Modellinstansen från queryset. Instansen kan nås i anpassade implementeringar av ChoiceWidget.create_option() för att justera den HTML som återges.

\n
\n\n

ModelChoiceIteratorValue har följande metod:

\n
\n
\n__str__()Link to this definition#
\n

Returnera värde som en sträng som ska återges i HTML.

\n
\n\n
\n\n
\n
\n
\n
\n

Skapa anpassade fältLink to this heading#

\n

Om de inbyggda Field-klasserna inte uppfyller dina behov kan du skapa egna Field-klasser. För att göra detta skapar du en underklass av django.forms.Field. Dess enda krav är att den implementerar en clean()-metod och att dess __init__()-metod accepterar de kärnargument som nämns ovan (required, label, initial, widget, help_text).

\n

Du kan också anpassa hur ett fält ska nås genom att åsidosätta bound_field_class eller åsidosätta Field.get_bound_field() om du behöver mer flexibilitet när du skapar BoundField:

\n
\n
\nField.get_bound_field(form, field_name)Link to this definition#
\n

Tar en instans av Form och namnet på fältet. Den returnerade BoundField-instansen kommer att användas vid åtkomst till fältet i en mall.

\n
\n\n

Se Anpassa BoundField för exempel på åsidosättande av en BoundField.

\n
","rootId":"module-django.forms.fields","toc":[{"title":"Argument för kärnområdet","anchor":"core-field-arguments","children":[{"title":"krävs","anchor":"required","children":[]},{"title":"etikett","anchor":"label","children":[]},{"title":"label_suffix","anchor":"label-suffix","children":[]},{"title":"initial","anchor":"initial","children":[]},{"title":"widget","anchor":"widget","children":[]},{"title":"hjälp_text","anchor":"help-text","children":[]},{"title":"Felmeddelanden","anchor":"error-messages","children":[]},{"title":"validerare","anchor":"validators","children":[]},{"title":"lokalisera","anchor":"localize","children":[]},{"title":"inaktiverad","anchor":"disabled","children":[]},{"title":"template_name","anchor":"template-name","children":[]},{"title":"bound_field_class","anchor":"bound-field-class","children":[]}]},{"title":"Kontroll av om fältdata har ändrats","anchor":"checking-if-the-field-data-has-changed","children":[{"title":"has_changed()","anchor":"has-changed","children":[]}]},{"title":"Inbyggda Field-klasser","anchor":"built-in-field-classes","children":[{"title":"BooleanField","anchor":"booleanfield","children":[]},{"title":"CharField","anchor":"charfield","children":[]},{"title":"ValField","anchor":"choicefield","children":[]},{"title":"DateField","anchor":"datefield","children":[]},{"title":"DatumTimeField","anchor":"datetimefield","children":[]},{"title":"DecimalField","anchor":"decimalfield","children":[]},{"title":"DurationField","anchor":"durationfield","children":[]},{"title":"EmailField","anchor":"emailfield","children":[]},{"title":"FileField","anchor":"filefield","children":[]},{"title":"FilePathField","anchor":"filepathfield","children":[]},{"title":"FloatField","anchor":"floatfield","children":[]},{"title":"GenericIPAddressField","anchor":"genericipaddressfield","children":[]},{"title":"ImageField","anchor":"imagefield","children":[]},{"title":"IntegerField","anchor":"integerfield","children":[]},{"title":"JSONField","anchor":"jsonfield","children":[]},{"title":"MultipleChoiceField","anchor":"multiplechoicefield","children":[]},{"title":"NullBooleanField","anchor":"nullbooleanfield","children":[]},{"title":"RegexField","anchor":"regexfield","children":[]},{"title":"SlugField","anchor":"slugfield","children":[]},{"title":"TimeField","anchor":"timefield","children":[]},{"title":"TypedChoiceField","anchor":"typedchoicefield","children":[]},{"title":"Typ av flervalsfält","anchor":"typedmultiplechoicefield","children":[]},{"title":"URL-fält","anchor":"urlfield","children":[]},{"title":"UUIDField","anchor":"uuidfield","children":[]}]},{"title":"Något komplexa inbyggda Field-klasser","anchor":"slightly-complex-built-in-field-classes","children":[{"title":"ComboField","anchor":"combofield","children":[]},{"title":"MultiValueField","anchor":"multivaluefield","children":[]},{"title":"SplitDateTimeField","anchor":"splitdatetimefield","children":[]}]},{"title":"Fält som hanterar relationer","anchor":"fields-which-handle-relationships","children":[{"title":"ModellValField","anchor":"modelchoicefield","children":[]},{"title":"ModellMultipleChoiceField","anchor":"modelmultiplechoicefield","children":[]},{"title":"Iteration av relationsval","anchor":"iterating-relationship-choices","children":[{"title":"ModelChoiceIterator","anchor":"modelchoiceiterator","children":[]},{"title":"ModelChoiceIteratorValue","anchor":"modelchoiceiteratorvalue","children":[]}]}]},{"title":"Skapa anpassade fält","anchor":"creating-custom-fields","children":[]}],"breadcrumbs":[{"docname":"ref/index","title":"API-referens","url":"/sv/5.2/ref/"},{"docname":"ref/forms/index","title":"Formulär","url":"/sv/5.2/ref/forms/"}],"prev":{"docname":"ref/forms/api","title":"API för formulär","url":"/sv/5.2/ref/forms/api/"},"next":{"docname":"ref/forms/models","title":"Modellformer","url":"/sv/5.2/ref/forms/models/"},"formats":{"html":"/sv/5.2/ref/forms/fields/","markdown":"/sv/5.2/ref/forms/fields.md","json":"/sv/5.2/ref/forms/fields.json"},"source":"https://github.com/django/django/blob/stable/5.2.x/docs/ref/forms/fields.txt","official":"https://docs.djangoproject.com/sv/5.2/ref/forms/fields/","inVersions":["6.1","6.0","5.2"],"inLocales":["en","sv","zh-hans","ga","fr","ja","id","it","pt-br","ko","es","el","pl"]}