_meta APILink to this heading#The model _meta API is at the core of the Django ORM. It enables other\nparts of the system such as lookups, queries, forms, and the admin to\nunderstand the capabilities of each model. The API is accessible through\nthe _meta attribute of each model class, which is an instance of an\ndjango.db.models.options.Options object.
Methods that it provides can be used to:
\nRetrieve all field instances of a model
Retrieve a single field instance of a model by name
Returns the field instance given a name of a field.
\nfield_name can be the name of a field on the model, a field\non an abstract or inherited model, or a field defined on another\nmodel that points to the model. In the latter case, the field_name\nwill be (in order of preference) the related_query_name\nset by the user, the related_name set by the user, or\nthe name automatically generated by Django.
Hidden fields cannot be retrieved\nby name.
If a field with the given name is not found a\nFieldDoesNotExist exception will be\nraised.
>>> from django.contrib.auth.models import User\n\n# A field on the model\n>>> User._meta.get_field('username')\n<django.db.models.fields.CharField: username>\n\n# A field from another model that has a relation with the current model\n>>> User._meta.get_field('logentry')\n<ManyToOneRel: admin.logentry>\n\n# A non existent field\n>>> User._meta.get_field('does_not_exist')\nTraceback (most recent call last):\n ...\nFieldDoesNotExist: User has no field named 'does_not_exist'\nReturns a tuple of fields associated with a model. get_fields() accepts\ntwo parameters that can be used to control which fields are returned:
include_parentsTrue by default. Recursively includes fields defined on parent\nclasses. If set to False, get_fields() will only search for\nfields declared directly on the current model. Fields from models that\ndirectly inherit from abstract models or proxy classes are considered\nto be local, not on the parent.
include_hiddenFalse by default. If set to True, get_fields() will include\nfields that are used to back other field’s functionality. This will\nalso include any fields that have a related_name (such\nas ManyToManyField, or\nForeignKey) that start with a “+”.
>>> from django.contrib.auth.models import User\n>>> User._meta.get_fields()\n(<ManyToOneRel: admin.logentry>,\n <django.db.models.fields.AutoField: id>,\n <django.db.models.fields.CharField: password>,\n <django.db.models.fields.DateTimeField: last_login>,\n <django.db.models.fields.BooleanField: is_superuser>,\n <django.db.models.fields.CharField: username>,\n <django.db.models.fields.CharField: first_name>,\n <django.db.models.fields.CharField: last_name>,\n <django.db.models.fields.EmailField: email>,\n <django.db.models.fields.BooleanField: is_staff>,\n <django.db.models.fields.BooleanField: is_active>,\n <django.db.models.fields.DateTimeField: date_joined>,\n <django.db.models.fields.related.ManyToManyField: groups>,\n <django.db.models.fields.related.ManyToManyField: user_permissions>)\n\n# Also include hidden fields.\n>>> User._meta.get_fields(include_hidden=True)\n(<ManyToOneRel: auth.user_groups>,\n <ManyToOneRel: auth.user_user_permissions>,\n <ManyToOneRel: admin.logentry>,\n <django.db.models.fields.AutoField: id>,\n <django.db.models.fields.CharField: password>,\n <django.db.models.fields.DateTimeField: last_login>,\n <django.db.models.fields.BooleanField: is_superuser>,\n <django.db.models.fields.CharField: username>,\n <django.db.models.fields.CharField: first_name>,\n <django.db.models.fields.CharField: last_name>,\n <django.db.models.fields.EmailField: email>,\n <django.db.models.fields.BooleanField: is_staff>,\n <django.db.models.fields.BooleanField: is_active>,\n <django.db.models.fields.DateTimeField: date_joined>,\n <django.db.models.fields.related.ManyToManyField: groups>,\n <django.db.models.fields.related.ManyToManyField: user_permissions>)\n