Django Get list of model fields

Question

I ve defined a User class which  ultimately  inherits from models Model  I want to get a list of all the fields defined for this model  For example  phone number   CharField max length 20   Basically  I want to retrieve anything that inherits from the Field class   I thought I d be able to retrieve these by taking advantage of inspect getmembers model   but the list it returns doesn t contain any of these fields  It looks like Django has already gotten a hold of the class and added all its magic attributes and stripped out what s actually been defined  So    how can I get these fields  They probably have a function for retrieving them for their own internal purposes

User · Accepted Answer

As most of answers are outdated I ll try to update you on Django 2 2 Here posts- your app  posts  blog  shop  etc   1  From model link  https   docs djangoproject com en stable ref models meta  from posts model import BlogPost  all fields   BlogPost  meta fields  or all fields   BlogPost  meta get fields    Note that  all fields BlogPost  meta get fields    Will also get some relationships  which  for ex  you can not display in a view  As in my case  Organisation  meta fields   lt django db models fields AutoField  id gt    lt django db models fields DateField  created gt      and Organisation  meta get fields     lt ManyToOneRel  crm activity gt    lt django db models fields AutoField  id gt    lt django db models fields DateField  created gt      2  From instance from posts model import BlogPost  bp   BlogPost   all fields   bp  meta fields  3  From parent model Let s suppose that we have Post as the parent model and you want to see all the fields in a list  and have the parent fields to be read-only in Edit mode  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

User · Answer

So before I found this post  I successfully found this to work   Model  meta fields   It works equally as   Model  meta get fields     I m not sure what the difference is in the results  if there is one  I ran this loop and got the same output   for field in Model  meta fields      print field name

User · Answer

In sometimes we need the db columns as well   def get db field names instance      your fields   instance  meta local fields    db field names  f name   id  if f related model is not None else f name  for f in your fields     model field names    f name for f in your fields     return db field names model field names  Call the method to get the fields  db field names model field names get db field names Mymodel

User · Answer

MyModel  meta get all field names   was deprecated several versions back and removed in Django 1 10   Here s the backwards-compatible suggestion from the docs   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

User · Answer

It is not clear whether you have an instance of the class or the class itself and trying to retrieve the fields  but either way  consider the following code  Using an 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   Using a class  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

User · Answer

At least with Django 1 9 9 -- the version I m currently using --  note that  get fields   actually also  considers  any foreign model as a field  which may be problematic  Say you have   class Parent models Model       id   UUIDField primary key True   class Child models Model       parent   models ForeignKey Parent    It follows that   gt  gt  gt  map lambda field field name  Parent  model  meta get fields      id    child     while  as shown by  Rockallite   gt  gt  gt  map lambda field field name  Parent  model  meta local fields    id

User · Answer

This does the trick  I only test it in Django 1 7   your fields   YourModel  meta local fields your field names    f name for f in your fields    Model  meta local fields does not contain many-to-many fields  You should get them using Model  meta local many to many

User · Answer

Just to add  I am using self object  this worked for me    f name for f in self model  meta get fields

User · Answer

The get all related fields   method mentioned herein has been deprecated in 1 8  From now on it s get fields      gt  gt  from django contrib auth models import User  gt  gt  User  meta get fields

User · Answer

I find adding this to django models quite helpful   def   iter   self       for field name in self  meta get all field names            value   getattr self  field name  None          yield  field name  value    This lets you do   for field  val in object      print field  val

User · Answer

Why not just use that   manage py inspectdb   Example output   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

User · Answer

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    This worked for me in django  1 11 8

User · Answer

Django versions 1 8 and later   You should use get fields      f name for f in MyModel  meta get fields      The get all field names   method is deprecated starting from Django 1 8 and will be removed in 1 10   The documentation page linked above provides a fully backwards-compatible implementation of get all field names    but for most purposes the previous example should work just fine      Django versions before 1 8   model  meta get all field names     That should do the trick   That requires an actual model instance  If all you have is a subclass of django db models Model  then you should call myproject myapp models MyModel  meta get all field names

[django] Django: Get list of model fields?

Examples related to django

Examples related to django-models