Django: obtenir la liste des champs du modèle?

J'ai défini une Userclasse dont (finalement) hérite models.Model. Je veux obtenir une liste de tous les champs définis pour ce modèle. Par exemple phone_number = CharField(max_length=20),. Fondamentalement, je veux récupérer tout ce qui hérite de la Fieldclasse.

J'ai pensé que je pourrais les récupérer en profitant de inspect.getmembers(model), mais la liste qu'il renvoie ne contient aucun de ces champs. Il semble que Django ait déjà saisi la classe et ajouté tous ses attributs magiques et supprimé ce qui a été réellement défini. Alors ... comment puis-je obtenir ces champs? Ils ont probablement une fonction pour les récupérer à leurs propres fins internes?

Comme la plupart des réponses sont obsolètes, j'essaierai de vous mettre à jour sur Django 2.2 Voici les articles - votre application (articles, blog, boutique, etc.)

1) Depuis le lien du modèle : https://docs.djangoproject.com/en/2.2/ref/models/meta/

from posts.model import BlogPost

all_fields = BlogPost._meta.fields
#or
all_fields = BlogPost._meta.get_fields()

Notez que:

all_fields=BlogPost._meta.get_fields()

Obtiendra également quelques relations, qui, par exemple: vous ne pouvez pas afficher dans une vue.
Comme dans mon cas:

Organisation._meta.fields
(<django.db.models.fields.AutoField: id>, <django.db.models.fields.DateField: created>...

et

Organisation._meta.get_fields()
(<ManyToOneRel: crm.activity>, <django.db.models.fields.AutoField: id>, <django.db.models.fields.DateField: created>...

2) De l'instance

from posts.model import BlogPost

bp = BlogPost()
all_fields = bp._meta.fields

3) Du modèle parent

Supposons que nous ayons Post comme modèle parent et que vous souhaitiez voir tous les champs dans une liste et que les champs parents soient en lecture seule en mode Édition.

from django.contrib import admin
from posts.model import BlogPost 

@admin.register(BlogPost)
class BlogPost(admin.ModelAdmin):
    all_fields = [f.name for f in Organisation._meta.fields]
    parent_fields = BlogPost.get_deferred_fields(BlogPost)

    list_display = all_fields
    read_only = parent_fields

Django versions 1.8 et supérieures:

Vous devez utiliser get_fields():

[f.name for f in MyModel._meta.get_fields()]

La get_all_field_names()méthode est obsolète à partir de Django 1.8 et sera supprimée en 1.10 .

La page de documentation liée ci-dessus fournit une implémentation entièrement compatible en amont de get_all_field_names(), mais pour la plupart des cas, l'exemple précédent devrait très bien fonctionner.

Versions de Django antérieures à 1.8:

model._meta.get_all_field_names()

Cela devrait faire l'affaire.

Cela nécessite une instance de modèle réelle. Si tout ce que vous avez est une sous-classe de django.db.models.Model, alors vous devez appelermyproject.myapp.models.MyModel._meta.get_all_field_names()

La get_all_related_fields()méthode mentionnée ici est déconseillée en 1.8 . À partir de maintenant, c'est get_fields().

>> from django.contrib.auth.models import User
>> User._meta.get_fields()

Je trouve cela utile pour les modèles django:

def __iter__(self):
    for field_name in self._meta.get_all_field_names():
        value = getattr(self, field_name, None)
        yield (field_name, value)

Cela vous permet de faire:

for field, val in object:
    print field, val

Cela fait l'affaire. Je le teste uniquement dans Django 1.7.

your_fields = YourModel._meta.local_fields
your_field_names = [f.name for f in your_fields]

Model._meta.local_fieldsne contient pas de champs plusieurs-à-plusieurs. Vous devriez les faire utiliser Model._meta.local_many_to_many.

Il n'est pas clair si vous avez une instance de la classe ou de la classe elle-même et que vous essayez de récupérer les champs, mais de toute façon, considérez le code suivant

Utiliser une instance

instance = User.objects.get(username="foo")
instance.__dict__ # returns a dictionary with all fields and their values
instance.__dict__.keys() # returns a dictionary with all fields
list(instance.__dict__.keys()) # returns list with all fields

Utiliser une classe

User._meta.__dict__.get("fields") # returns the fields

# to get the field names consider looping over the fields and calling __str__()
for field in User._meta.__dict__.get("fields"):
    field.__str__() # e.g. 'auth.User.id'

def __iter__(self):
    field_names = [f.name for f in self._meta.fields]
    for field_name in field_names:
        value = getattr(self, field_name, None)
        yield (field_name, value)

Cela a fonctionné pour moi dans django==1.11.8

MyModel._meta.get_all_field_names()a été déconseillé plusieurs versions en arrière et supprimé dans Django 1.10.

Voici la suggestion de compatibilité descendante des documents :

from itertools import chain

list(set(chain.from_iterable(
    (field.name, field.attname) if hasattr(field, 'attname') else (field.name,)
    for field in MyModel._meta.get_fields()
    # For complete backwards compatibility, you may want to exclude
    # GenericForeignKey from the results.
    if not (field.many_to_one and field.related_model is None)
)))

Juste pour ajouter, j'utilise l'auto-objet, cela a fonctionné pour moi:

[f.name for f in self.model._meta.get_fields()]

Au moins avec Django 1.9.9 - la version que j'utilise actuellement -, notez qu'en .get_fields()fait "considère" également tout modèle étranger comme un champ, ce qui peut être problématique. Dites que vous avez:

class Parent(models.Model):
    id = UUIDField(primary_key=True)

class Child(models.Model):
    parent = models.ForeignKey(Parent)

Il s'ensuit que

>>> map(lambda field:field.name, Parent._model._meta.get_fields())
['id', 'child']

tandis que, comme le montre @Rockallite

>>> map(lambda field:field.name, Parent._model._meta.local_fields)
['id']

Donc, avant de trouver ce post, j'ai réussi à le trouver.

Model._meta.fields

Cela fonctionne aussi bien que

Model._meta.get_fields()

Je ne sais pas quelle est la différence dans les résultats, s'il y en a un. J'ai exécuté cette boucle et obtenu la même sortie.

for field in Model._meta.fields:
    print(field.name)

Pourquoi ne pas simplement utiliser cela:

manage.py inspectdb

Exemple de sortie:

class GuardianUserobjectpermission(models.Model):
    id = models.IntegerField(primary_key=True)  # AutoField?
    object_pk = models.CharField(max_length=255)
    content_type = models.ForeignKey(DjangoContentType, models.DO_NOTHING)
    permission = models.ForeignKey(AuthPermission, models.DO_NOTHING)
    user = models.ForeignKey(CustomUsers, models.DO_NOTHING)

    class Meta:
        managed = False
        db_table = 'guardian_userobjectpermission'
        unique_together = (('user', 'permission', 'object_pk'),)