Итерация по именам полей экземпляра модели и значениям в шаблоне

Я пытаюсь создать базовый шаблон для отображения значений полей выбранного экземпляра, вместе с их именами. Подумайте об этом как о стандартном выводе значений этого экземпляра в формате таблицы с именем Поля (verbose_name, если оно указано в поле) в первом столбце и значением этого поля во втором столбце.

например, предположим, что у нас есть следующее определение модели:

class Client(Model):
    name = CharField(max_length=150)
    email = EmailField(max_length=100, verbose_name="E-mail")

Я хотел бы, чтобы он был выведен в шаблон типа so (предположим, экземпляр с заданными значениями):

Field Name      Field Value
----------      -----------
Name            Wayne Koorts
E-mail          waynes@email.com

то, что я пытаюсь достичь, - это возможность передать экземпляр модели шаблону и иметь возможность динамически перебирать его в шаблоне, что-то вроде этого:

<table>
    {% for field in fields %}
        <tr>
            <td>{{ field.name }}</td>
            <td>{{ field.value }}</td>
        </tr>
    {% endfor %}
</table>

есть ли аккуратный, "одобренный Джанго" способ сделать это? Это кажется очень распространенной задачей, и мне нужно будет делать это часто для этого конкретного проекта.

20 ответов


model._meta.get_all_field_names() даст вам все имена полей модели, затем вы можете использовать model._meta.get_field() чтобы проложить свой путь к подробному имени и getattr(model_instance, 'field_name') получить значение из модели.

Примечание: model._meta.get_all_field_names() устарел в django 1.9. Вместо этого используйте model._meta.get_fields() чтобы получить поля модели и field.name получить имя каждого поля.


можно использовать to-python объект QuerySet сериализатор.

просто поместите следующий код в ваш вид:

from django.core import serializers
data = serializers.serialize( "python", SomeModel.objects.all() )

и затем в шаблоне:

{% for instance in data %}
    {% for field, value in instance.fields.items %}
        {{ field }}: {{ value }}
    {% endfor %}
{% endfor %}

его большим преимуществом является тот факт, что он обрабатывает поля отношений.

для подмножества полей попробовать:

data = serializers.serialize('python', SomeModel.objects.all(), fields=('name','size'))

наконец-то нашел хорошее решение для этого на список рассылки dev:

в окне Добавить:

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})

в шаблоне добавить:

{% for field in object %}
    <li><b>{{ field.label }}:</b> {{ field.data }}</li>
{% endfor %}

в свете выпуска Django 1.8 (и формализации модель _meta API, я решил, что обновлю это с более поздним ответом.

предполагая ту же модель:

class Client(Model):
    name = CharField(max_length=150)
    email = EmailField(max_length=100, verbose_name="E-mail")

Джанго
fields = [(f.verbose_name, f.name) for f in Client._meta.fields]
>>> fields
[(u'ID', u'id'), (u'name', u'name'), (u'E-mail', u'email')]

Django 1.8+ (формализованная модель _META API)

изменено в Django 1.8:

Модель _meta API всегда существовал как внутренний Django, но не было официально задокументировано и поддержано. В рамках усилий по публикации этого API некоторые из уже существующих точек входа API немного изменились. Для преобразования кода в новый официальный API было предоставлено руководство по миграции.

в приведенном ниже примере мы будем использовать формализованный метод получение всех экземпляров поля модели via Client._meta.get_fields():

fields = [(f.verbose_name, f.name) for f in Client._meta.get_fields()]
>>> fields
[(u'ID', u'id'), (u'name', u'name'), (u'E-mail', u'email')]

на самом деле, это было доведено до моего внимания что вышеизложенное немного за бортом для того, что было необходимо (я согласен!). Простое лучше сложного. Я оставляю вышеизложенное для справки. Однако для отображения в шаблоне лучше всего использовать ModelForm и передать экземпляр. Вы можете выполнить итерацию по форме (эквивалент итерации по каждому из полей формы) и использовать атрибут label для получения имени verbose_name поля модели, а также использовать метод 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}
    )

теперь мы визуализируем поля в шаблоне:

<table>
    <thead>
        {% for field in form %}
            <th>{{ field.label }}</th>
        {% endfor %}
    </thead>
    <tbody>
        <tr>
            {% for field in form %}
                <td>{{ field.value|default_if_none:'' }}</td>
            {% endfor %}
        </tr>
    </tbody>
</table>

вот еще один подход, использующий метод модели. Эта версия разрешает поля раскрывающегося списка / выбора, пропускает пустые поля и позволяет исключить определенные поля.

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

тогда в вашем шаблоне:

{% for f in app.get_all_fields %}
  <dt>{{f.label|capfirst}}</dt>
    <dd>
      {{f.value|escape|urlize|linebreaks}}
    </dd>
{% endfor %}

Ок, я знаю, что это немного поздно, но так как я наткнулся на это, прежде чем найти правильный ответ, так что может кто-то еще.

С Джанго документы:

# This list contains a Blog object.
>>> Blog.objects.filter(name__startswith='Beatles')
[<Blog: Beatles Blog>]

# This list contains a dictionary.
>>> Blog.objects.filter(name__startswith='Beatles').values()
[{'id': 1, 'name': 'Beatles Blog', 'tagline': 'All the latest Beatles news.'}]

вы можете иметь форму сделать работу за вас.

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})

затем в шаблоне:

<table>
    {% for field in form %}
        <tr>
            <td>{{ field.name }}</td>
            <td>{{ field.value }}</td>
        </tr>
    {% endfor %}
</table>

можно использовать values() метод a queryset, которая возвращает словарь. Кроме того, этот метод принимает список полей для подмножества. The values() метод не будет работать с get(), так что вы должны использовать filter() (см. QuerySet API).

на view...

def show(request, object_id):
   object = Foo.objects.filter(id=object_id).values()[0]
   return render_to_response('detail.html', {'object': object})

на detail.html...

<ul>
   {% for key, value in object.items %}
        <li><b>{{ key }}:</b> {{ value }}</li>
   {% endfor %}
</ul>

на коллекция экземпляров возвращенного фильтра:

   object = Foo.objects.filter(id=object_id).values() # no [0]

In деталь.HTML-код...

{% for instance in object %}
<h1>{{ instance.id }}</h1>
<ul>
    {% for key, value in instance.items %}
        <li><b>{{ key }}:</b>  {{ value }}</li>
    {% endfor %}
</ul>
{% endfor %}

там должен быть встроенный способ сделать это. Я написал эту утилиту build_pretty_data_view который принимает объект модели и экземпляр формы (форма на основе вашей модели) и возвращает SortedDict.

преимущества этого решения включают в себя:

  • он сохраняет порядок, используя встроенный Django SortedDict.
  • когда пытается получить label / verbose_name, но возвращается к имени Поля, если оно не определено.
  • оно также выборочно примет exclude() список имен полей для исключения определенных полей.
  • если ваш класс формы включает в себя Meta: exclude(), но вы все еще хотите вернуть значения, а затем добавить эти поля в дополнительный append() список.

чтобы использовать это решение, сначала добавьте этот файл/функцию где-нибудь, а затем импортируйте его в свой 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

Итак, теперь в вашем views.py вы можете сделать что-то подобное

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,}))

теперь в вашем my-template.html шаблон вы можете перебирать данные так...

{% for field,value in data.items %}

    <p>{{ field }} : {{value.label}}: {{value.fieldvalue}}</p>

{% endfor %}

Удачи. Надеюсь, это кому-то поможет!


ниже мой, вдохновленный shacker это!--5--> get_all_fields. Он получает dict одного экземпляра модели, если поле связи encounter, то ASign значение поля dict рекурсивно.

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

эта функция в основном используется для сброса экземпляра модели в данные json:

def to_json(self):
    tree = to_dict(self, exclude=('id', 'User.password'))
    return json.dumps(tree, ensure_ascii=False)

Я https://stackoverflow.com/a/3431104/2022534 но заменить model_to_dict Джанго() с этим смогут справиться отношения 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

обратите внимание, что я немного упростил его, удалив части оригинала, которые мне не нужны. Возможно, ты захочешь положить их обратно.


вместо редактирования каждой модели я бы рекомендовал писать один тег шаблона который вернет все поле любая модель дали.
Каждый объект имеет список полей ._meta.fields.
Каждый объект поля имеет атрибут name, что вернет его имя и метод value_to_string(), который поставляется с вашей моделью object вернет его стоимость.
Остальное так же просто, как сказано в документация Django.

вот мой например как этот templatetag может выглядеть так:

    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 <object> [as <context_name>] %}")

Да, это не очень красиво, вам придется сделать свою собственную обертку. Взгляните на строение -databrowse приложение, которое имеет все функции, которые вам действительно нужны.


Это можно считать взломом, но я сделал это перед использованием modelform_factory, чтобы превратить экземпляр модели в форму.

класс формы имеет гораздо больше информации внутри, что очень легко перебирать, и он будет служить той же цели за счет немного больше накладных расходов. Если ваши размеры набора относительно малы, я думаю, что влияние на производительность будет незначительным.

одно из преимуществ, кроме удобства, конечно, что вы можете легко превратить в стол в редактируемый datagrid на более позднюю дату.


Я придумал следующий метод, который работает для меня, потому что в каждом случае модель будет иметь связанную с ней ModelForm.

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)

вот выдержка из шаблона, который я использую для этого конкретного представления:

<table class="client-view">
    <tbody>
    {% for field, value in model_data.items %}
        <tr>
            <td class="field-name">{{ field }}</td><td>{{ value }}</td>
        </tr>
    {% endfor %}
    </tbody>
</table>

хорошая вещь об этом методе заключается в том, что я могу выбрать на основе шаблона по шаблону порядок, в котором я хотел бы отобразить метки полей, используя кортеж, переданный для GetModelData и указав имена полей. Этот также позволяет исключить некоторые поля (например, внешний ключ пользователя), поскольку в окончательный словарь встроены только имена полей, переданные через кортеж.

Я не собираюсь принимать это как ответ, потому что я уверен, что кто-то может придумать что-то более "Djangonic" :-)

обновление: я выбираю это как окончательный ответ, потому что это самый простой из тех, кто делает то, что мне нужно. Спасибо всем, кто дал ответы.


Django 1.7 решение для меня:

существуют переменные, точные для вопроса, но вы определенно должны быть в состоянии рассечь этот пример

ключ здесь в значительной степени использовать .__dict__ модели
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)

шаблон:

{% for field in gen_house %}
    {% if field != '_state' %}
        {{ gen_house|getattribute:field }}
    {% endif %}
{% endfor %}

в шаблоне я использовал фильтр для доступа к полю в 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 ""

Я использую это,https://github.com/miracle2k/django-tables.

<table>
<tr>
    {% for column in table.columns %}
    <th><a href="?sort={{ column.name_toggled }}">{{ column }}</a></th>
    {% endfor %}
</tr>
{% for row in table.rows %}
    <tr>
    {% for value in row %}
        <td>{{ value }}</td>
    {% endfor %}
    </tr>
{% endfor %}
</table>

этот подход показывает, как использовать класс, такой как ModelForm django, и тег шаблона, такой как {{ form.as_table }}, но вся таблица выглядит как вывод данных, а не форма.

первым шагом был подкласс виджета TextInput django:

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'<p %s>%s</p>' % (flatatt(final_attrs),value))

затем я подкласса ModelForm Джанго поменять виджеты по умолчанию для чтения версии:

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" 

Это были единственные виджеты, которые мне нужны. Но нетрудно распространить эту идею и на других. штучки.


просто редактирование @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

пусть Django обрабатывает все другие поля, кроме связанных полей. Я чувствую, что это более стабильно


посмотри django-etc приложение. Он имеет model_field_verbose_name тег шаблона для получения подробного имени Поля из шаблонов:http://django-etc.rtfd.org/en/latest/models.html#model-field-template-tags