Iterate over model instance field names and values in template

Question

I m trying to create a basic template to display the selected instance s field values  along with their names   Think of it as just a standard output of the values of that instance in table format  with the field name  verbose name specifically if specified on the field  in the first column and the value of that field in the second column   For example  let s say we have the following model definition   class Client Model       name   CharField max length 150      email   EmailField max length 100  verbose name  E-mail     I would want it to be output in the template like so  assume an instance with the given values    Field Name      Field Value ----------      ----------- Name            Wayne Koorts E-mail          waynes email com   What I m trying to achieve is being able to pass an instance of the model to a template and be able to iterate over it dynamically in the template  something like this    lt table gt         for field in fields             lt tr gt               lt td gt    field name    lt  td gt               lt td gt    field value    lt  td gt           lt  tr gt         endfor     lt  table gt    Is there a neat   Django-approved  way to do this   It seems like a very common task  and I will need to do it often for this particular project

User · Answer

Django 1 7 solution for me   There variables are exact to the question  but you should definitely be able to dissect this example  The key here is to pretty much use the    dict   of the model views py   def display specific request  key     context          question id  question id       client  Client objects get pk key    dict          return render request   general household view specific html   context    template      for field in gen house           if field      state                gen house getattribute field           endif       endfor      in the template I used a filter to access the field in the dict filters py    register filter name  getattribute   def getattribute value  arg     if value is None or arg is None      return      try      return value arg    except KeyError      return      except TypeError      return

User · Answer

This approach shows how to use a class like django s ModelForm and a template tag like    form as table     but have all the table look like data output  not a form   The first step was to subclass django s TextInput widget   from django import forms from django utils safestring import mark safe from django forms util import flatatt  class PlainText forms TextInput       def render self  name  value  attrs None           if value is None              value              final attrs   self build attrs attrs          return mark safe u  lt p  s gt  s lt  p gt      flatatt final attrs  value     Then I subclassed django s ModelForm to swap out the default widgets for readonly versions   from django forms import ModelForm  class ReadOnlyModelForm ModelForm       def   init   self  args   kwrds           super ReadOnlyModelForm self    init    args   kwrds          for field in self fields              if isinstance self fields field  widget forms TextInput  or                  isinstance self fields field  widget forms Textarea                   self fields field  widget PlainText               elif isinstance self fields field  widget forms CheckboxInput                   self fields field  widget attrs  disabled    disabled     Those were the only widgets I needed  But it should not be difficult to extend this idea to other widgets

User · Answer

Just an edit of  wonder  def to dict obj  exclude          tree          for field in obj  meta fields   obj  meta many to many          if field name in exclude or                s  s     type obj    name    field name  in exclude              continue         try               value   getattr obj  field name          except obj DoesNotExist as e              value   None         except ObjectDoesNotExist as e              value   None             continue         if type field  in  ForeignKey  OneToOneField               tree field name    to dict value  exclude exclude          elif isinstance field  ManyToManyField               vs                  for v in value all                    vs append to dict v  exclude exclude               tree field name    vs         else              tree field name    obj serializable value field name      return tree   Let Django handle all the other fields other than the related fields  I feel that is more stable

User · Answer

There should really be a built-in way to do this   I wrote this utility build pretty data view that takes a model object and form instance  a form based on your model  and returns a SortedDict   Benefits to this solution include    It preserves order using Django s built-in SortedDict  When tries to get the label verbose name  but falls back to the field name if one is not defined   It will also optionally take an exclude   list of field names to exclude certain fields   If your form class includes a Meta  exclude    but you still want to return the values  then add those fields to the optional append   list      To use this solution  first add this file function somewhere  then import it into your views py   utils py     usr bin env python   - - coding  utf-8 - -   vim  ai ts 4 sts 4 et sw 4 from django utils datastructures import SortedDict   def build pretty data view form instance  model object  exclude     append          i 0     sd SortedDict        for j in append          try              sdvalue   label  j capitalize                          fieldvalue  model object   getattribute   j               sd insert i  j  sdvalue              i  1         except AttributeError               pass      for k v in form instance fields items            sdvalue   label       fieldvalue              if not exclude   contains   k               if v label is not None                  sdvalue     label  v label                              fieldvalue   model object   getattribute   k               else                  sdvalue     label  k                              fieldvalue   model object   getattribute   k               sd insert i  k  sdvalue              i  1     return sd   So now in your views py you might do something like this  from django shortcuts import render to response from django template import RequestContext from utils import build pretty data view from models import Blog from forms import BlogForm     def my view request      b Blog objects get pk 1     bf BlogForm instance b     data build pretty data view form instance bf  model object b                          exclude   number of comments    number of likes                            append   user         return render to response  my-template html                             RequestContext request                                             data  data       Now in your my-template html template you can iterate over the data like so        for field value in data items          lt p gt    field        value label      value fieldvalue   lt  p gt      endfor      Good Luck  Hope this helps someone

User · Answer

Instead of editing every model I would recommend to write one template tag which will return all field of any model given    Every object has list of fields   meta fields  Every field object has attribute name that will return it s name and method value to string   that supplied with your model object will return its value  The rest is as simple as it s said in Django documentation   Here is my example how this templatetag might look like       from django conf import settings     from django import template      if not getattr settings   DEBUG   False           raise template TemplateSyntaxError  get fields is available only when DEBUG   True         register   template Library        class GetFieldsNode template Node           def   init   self  object  context name None               self object   template Variable object              self context name   context name          def render self  context               object   self object resolve context              fields     field name  field value to string object   for field in object  meta fields               if self context name                  context self context name    fields                 return                else                  return fields        register tag     def get fields parser  token           bits   token split contents            if len bits     4 and bits 2      as               return GetFieldsNode bits 1   context name bits 3           elif len bits     2              return GetFieldsNode bits 1           else              raise template TemplateSyntaxError  get fields expects a syntax of                                  get fields  lt object gt   as  lt context name gt

User · Answer

You can have a form do the work for you   def my model view request  mymodel id       class MyModelForm forms ModelForm           class Meta              model   MyModel      model   get object or 404 MyModel  pk mymodel id      form   MyModelForm instance model      return render request   model html      form   form     Then in the template    lt table gt         for field in form             lt tr gt               lt td gt    field name    lt  td gt               lt td gt    field value    lt  td gt           lt  tr gt         endfor     lt  table gt

User · Answer

I just tested something like this in shell and seems to do it s job   my object mapped    attr name  str getattr my object  attr name   for attr in MyModel  meta fields    Note that if you want str   representation for foreign objects you should define it in their str method  From that you have dict of values for object  Then you can render some kind of template or whatever

User · Answer

Take a look at django-etc application  It has model field verbose name template tag to get field verbose name from templates  http   django-etc rtfd org en latest models html model-field-template-tags

User · Answer

Below is mine  inspired by shacker s get all fields  It gets a dict of one model instance  if encounter relation field  then asign the field value a dict recursively   def to dict obj  exclude                  dict         model instance                 tree          for field in obj  meta fields   obj  meta many to many          if field name in exclude or                s  s     type obj    name    field name  in exclude              continue          try               value   getattr obj  field name          except obj DoesNotExist              value   None          if type field  in  ForeignKey  OneToOneField               tree field name    to dict value  exclude exclude          elif isinstance field  ManyToManyField               vs                  for v in value all                    vs append to dict v  exclude exclude               tree field name    vs         elif isinstance field  DateTimeField               tree field name    str value          elif isinstance field  FileField               tree field name      url   value url          else              tree field name    value      return tree   This function is mainly used to dump a model instance to json data   def to json self       tree   to dict self  exclude   id    User password        return json dumps tree  ensure ascii False

User · Answer

You can use Django s to-python queryset serializer   Just put the following code in your view   from django core import serializers data   serializers serialize   python   SomeModel objects all       And then in the template      for instance in data           for field  value in instance fields items               field        value           endfor       endfor      Its great advantage is the fact that it handles relation fields   For the subset of fields try   data   serializers serialize  python   SomeModel objects all    fields   name   size

User · Answer

Finally found a good solution to this on the dev mailing list   In the view add   from django forms models import model to dict  def show request  object id       object   FooForm data model to dict Foo objects get pk object id        return render to response  foo foo detail html     object   object     in the template add      for field in object         lt li gt  lt b gt    field label     lt  b gt     field data    lt  li gt     endfor

User · Answer

This may be considered a hack but I ve done this before using modelform factory to turn a model instance into a form   The Form class has a lot more information inside that s super easy to iterate over and it will serve the same purpose at the expense of slightly more overhead  If your set sizes are relatively small I think the performance impact would be negligible   The one advantage besides convenience of course is that you can easily turn the table into an editable datagrid at a later date

User · Answer

Yeah it s not pretty  you ll have to make your own wrapper  Take a look at builtin databrowse app  which has all the functionality you need really

User · Answer

In light of Django 1 8 s release  and the formalization of the Model  meta API  I figured I would update this with a more recent answer  Assuming the same model  class Client Model       name   CharField max length 150      email   EmailField max length 100  verbose name  quot E-mail quot    Django  lt   1 7 fields     f verbose name  f name  for f in Client  meta fields   gt  gt  gt  fields   u ID   u id     u name   u name     u E-mail   u email     Django 1 8   formalized Model  meta API   Changed in Django 1 8  The Model  meta API has always existed as a Django internal  but wasn   t formally documented and supported  As part of the effort to make this API public  some of the already existing API entry points have changed slightly  A migration guide has been provided to assist in converting your code to use the new  official API   In the below example  we will utilize the formalized method for retrieving all field instances of a model via Client  meta get fields    fields     f verbose name  f name  for f in Client  meta get fields     gt  gt  gt  fields   u ID   u id     u name   u name     u E-mail   u email     Actually  it has been brought to my attention that the above is slightly overboard for what was needed  I agree    Simple is better than complex  I am leaving the above for reference  However  to display in the template  the best method would be to use a ModelForm and pass in an instance  You can iterate over the form  equivalent of iterating over each of the form s fields  and use the label attribute to retrieve the verbose name of the model field  and use the value method to retrieve the value  from django forms import ModelForm from django shortcuts import get object or 404  render from  models import Client  def my view request  pk       instance   get object or 404 Client  pk pk           class ClientForm ModelForm           class Meta              model   Client             fields     name    email        form   ClientForm instance instance       return render          request           template name  template html             form   form         Now  we render the fields in the template   lt table gt       lt thead gt             for field in form                 lt th gt    field label    lt  th gt             endfor         lt  thead gt       lt tbody gt           lt tr gt                 for field in form                     lt td gt    field value default if none       lt  td gt                 endfor             lt  tr gt       lt  tbody gt   lt  table gt

User · Answer

model  meta get all field names   will give you all the model s field names  then you can use model  meta get field   to work your way to the verbose name  and getattr model instance   field name   to get the value from the model   NOTE  model  meta get all field names   is deprecated in django 1 9  Instead use model  meta get fields   to get the model s fields and field name to get each field name

User · Answer

Here s another approach using a model method  This version resolves picklist choice fields  skips empty fields  and lets you exclude specific fields    def get all fields self          Returns a list of all field names on the instance         fields          for f in self  meta fields           fname   f name                   resolve picklists choices  with get xyz display   function         get choice    get   fname   display          if hasattr self  get choice               value   getattr self  get choice            else              try                  value   getattr self  fname              except AttributeError                  value   None            only display fields with values and skip some fields entirely         if f editable and value and f name not in   id    status    workshop    user    complete                  fields append                                  label  f verbose name                   name  f name                   value  value                                    return fields   Then in your template      for f in app get all fields       lt dt gt   f label capfirst   lt  dt gt       lt dd gt          f value escape urlize linebreaks        lt  dd gt     endfor

User · Answer

Ok  I know this is a bit late  but since I stumbled upon this before finding the correct answer so might someone else   From the django docs     This list contains a Blog object   gt  gt  gt  Blog objects filter name  startswith  Beatles     lt Blog  Beatles Blog gt      This list contains a dictionary   gt  gt  gt  Blog objects filter name  startswith  Beatles   values      id   1   name    Beatles Blog    tagline    All the latest Beatles news

User · Answer

You can use the values   method of a queryset  which returns a dictionary  Further  this method accepts a list of fields to subset on  The values   method will not work with get    so you must use filter    refer to the QuerySet API    In view     def show request  object id      object   Foo objects filter id object id  values   0     return render to response  detail html     object   object     In detail html      lt ul gt        for key  value in object items             lt li gt  lt b gt    key     lt  b gt     value    lt  li gt        endfor     lt  ul gt    For a collection of instances returned by filter      object   Foo objects filter id object id  values     no  0    In detail html        for instance in object     lt h1 gt    instance id    lt  h1 gt   lt ul gt         for key  value in instance items             lt li gt  lt b gt    key     lt  b gt      value    lt  li gt         endfor     lt  ul gt     endfor

User · Answer

x000D   x000D   lt table border  1  gt  x000D    lt tr gt  x000D       for mfild in fields   x000D      lt td gt   mfild   lt  td gt  x000D       endfor   x000D    lt  tr gt  x000D        for v in records   x000D           lt tr gt  x000D            lt td gt   v id   lt  td gt  x000D            lt td gt   v title   lt  td gt  x000D            lt td class    gt   v desc   lt  td gt  x000D   x000D           lt  tr gt  x000D   x000D         endfor   x000D    lt  table gt  x000D    x000D    x000D  enter code here x000D   x000D   x000D

User · Answer

I used https   stackoverflow com a 3431104 2022534 but replaced Django s model to dict   with this to be able to handle ForeignKey   def model to dict instance       data          for field in instance  meta fields          data field name    field value from object instance          if isinstance field  ForeignKey               data field name    field rel to objects get pk data field name       return data   Please note that I have simplified it quite a bit by removing the parts of the original I didn t need  You might want to put those back

User · Answer

I ve come up with the following method  which works for me because in every case the model will have a ModelForm associated with it   def GetModelData form  fields               Extract data from the bound form model instance and return a     dictionary that is easily usable in templates with the actual     field verbose name as the label  e g       model data  Address line 1    32 Memory lane                   Address line 2    Brainville                   Phone    0212378492        This way  the template has an ordered list that can be easily     presented in tabular form              model data          for field in fields          model data form field  label    eval  form data  s    form field  name      return model data   login required def clients view request  client id       client   Client objects get id client id      form   AddClientForm client       fields     address1    address2    address3    address4                  phone    fax    mobile    email       model data   GetModelData form  fields       template vars   RequestContext request                         client   client               model data   model data                     return render to response  clients-view html   template vars    Here is an extract from the template I am using for this particular view    lt table class  client-view  gt       lt tbody gt         for field  value in model data items             lt tr gt               lt td class  field-name  gt    field    lt  td gt  lt td gt    value    lt  td gt           lt  tr gt         endfor         lt  tbody gt   lt  table gt    The nice thing about this method is that I can choose on a template-by-template basis the order in which I would like to display the field labels  using the tuple passed in to GetModelData and specifying the field names   This also allows me to exclude certain fields  e g  a User foreign key  as only the field names passed in via the tuple are built into the final dictionary   I m not going to accept this as the answer because I m sure someone can come up with something more  Djangonic   -   Update  I m choosing this as the final answer because it is the simplest out of those given that does what I need   Thanks to everyone who contributed answers

User · Answer

I m using this  https   github com miracle2k django-tables    lt table gt   lt tr gt         for column in table columns         lt th gt  lt a href   sort    column name toggled     gt    column    lt  a gt  lt  th gt         endfor     lt  tr gt     for row in table rows         lt tr gt         for value in row             lt td gt    value    lt  td gt         endfor         lt  tr gt     endfor     lt  table gt

User · Answer

Django    2 0  Add get fields   to your models py   class Client Model       name   CharField max length 150      email   EmailField max length 100  verbose name  E-mail        def get fields self           return   field verbose name  field value from object self   for field in self   class    meta fields    Then call it as object get fields on your template html    lt table gt         for label  value in object get fields             lt tr gt               lt td gt    label    lt  td gt               lt td gt    value    lt  td gt           lt  tr gt         endfor     lt  table gt

[python] Iterate over model instance field names and values in template

Examples related to python

Examples related to django

Examples related to django-templates