help_text - Django Integrierte Feldvalidierung
Integrierte Feldvalidierungen in Django-Modellen sind die Validierungen, die für alle Django-Felder vordefiniert sind. Jedes Feld enthält integrierte Validierungen von Django- Validatoren . Sie können auch mehr integrierte Feldvalidierungen hinzufügen, um bestimmte Einschränkungen für ein bestimmtes Feld anzuwenden oder zu entfernen.
help_text
Das Attribut wird verwendet, um den Hilfetext zusammen mit dem Feld in Form in der Administrationsoberfläche oder in ModelForm anzuzeigen. Es ist nützlich für die Dokumentation, auch wenn Ihr Feld nicht in einem Formular verwendet wird. Beispielsweise können Sie das help_text
Datumsmuster definieren, das als Eingabe in DateField verwendet werden soll.
Syntax-
field_name = models.Field (help_text = "text")
help_text
Erläuterung zur integrierten Django-Feldvalidierung
Illustration von help_text anhand eines Beispiels. Stellen Sie sich ein Projekt mit dem Namen geeksforgeeks
einer App vor geeks
.
In den folgenden Artikeln erfahren Sie, wie Sie ein Projekt und eine App in Django erstellen.
Geben Sie den folgenden Code in die models.py
Datei der Geeks App ein. Wir werden DateField verwenden, um mit help_text zu experimentieren.
from
django.db
import
models
from
django.db.models
import
Model
class
GeeksModel(Model):
geeks_field
=
models.DateField(
help_text
=
"Please use the following format: <em>YYYY-MM-DD</em>."
)
Nachdem Sie makemigrations ausgeführt und auf Django migriert und das obige Modell gerendert haben, überprüfen Sie, ob in unserem Feld in der Django-Administratoroberfläche etwas passiert ist.
Sie können zusätzlichen Text am unteren Rand des Feldes sehen. Auf diese Weise können Sie den Text ändern, der in ModelForm unter Ihrem Feld angezeigt wird.
Erweiterte Konzepte mit help_text
-
=> Was mache ich, help_text wird auch nach vielen Versuchen nicht angezeigt?
Wenn Sie {{ form.as_p }}
(oder nur {{ form }}
) in Ihre Vorlage einfügen, sollte der Hilfetext ohne zusätzlichen Code angezeigt werden, vorausgesetzt, Sie haben ein Formular in Ihrem Kontext oder wenn Sie einzelne Felder verwenden, können Sie auf den Hilfetext {{ form.field.help_text }}
eines bestimmten Felds zugreifen.
Weitere integrierte Feldvalidierungen
Feldoptionen | Beschreibung |
---|---|
Null | Wenn True , speichert Django leere Werte als NULL in der Datenbank. Standard ist False . |
Leer | Wenn True , darf das Feld leer sein. Standard ist False . |
db_column | Der Name der Datenbankspalte, die für dieses Feld verwendet werden soll. Wenn dies nicht angegeben ist, verwendet Django den Feldnamen. |
Standard | Der Standardwert für das Feld. Dies kann ein Wert oder ein aufrufbares Objekt sein. Wenn aufrufbar, wird es jedes Mal aufgerufen, wenn ein neues Objekt erstellt wird. |
Hilfstext | Zusätzlicher Hilfetext, der mit dem Formular-Widget angezeigt werden soll. Es ist nützlich für die Dokumentation, auch wenn Ihr Feld nicht in einem Formular verwendet wird. |
Primärschlüssel | Wenn True, ist dieses Feld der Primärschlüssel für das Modell. |
editierbar | Bei False wird das Feld weder im Administrator noch in einem anderen ModelForm angezeigt. Sie werden auch während der Modellvalidierung übersprungen. Standard ist True . |
Fehlermeldungen | Mit dem Argument error_messages können Sie die Standardnachrichten überschreiben, die das Feld auslösen wird. Übergeben Sie ein Wörterbuch mit Schlüsseln, die den Fehlermeldungen entsprechen, die Sie überschreiben möchten. |
Hilfstext | Zusätzlicher Hilfetext, der mit dem Formular-Widget angezeigt werden soll. Es ist nützlich für die Dokumentation, auch wenn Ihr Feld nicht in einem Formular verwendet wird. |
verbose_name | Ein für Menschen lesbarer Name für das Feld. Wenn der ausführliche Name nicht angegeben wird, erstellt Django ihn automatisch unter Verwendung des Attributnamens des Felds und konvertiert Unterstriche in Leerzeichen. |
Validatoren | Eine Liste der Validatoren, die für dieses Feld ausgeführt werden sollen. Weitere Informationen finden Sie in der Validator-Dokumentation . |
Einzigartig | Wenn True, muss dieses Feld in der gesamten Tabelle eindeutig sein. |