Ітерація над іменами полів екземплярів моделі та значеннями в шаблоні

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

Наприклад, скажімо, у нас є таке визначення моделі:

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

Я хотів би, щоб це було виведено у такому шаблоні (припустимо, екземпляр із заданими значеннями):

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>

Чи є акуратний, "схвалений" Джанго "спосіб це зробити? Це здається дуже поширеним завданням, і мені потрібно буде робити це часто для цього конкретного проекту.

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отримання назви кожного поля.

Ви можете використовувати Джанго к-пітона 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'))

Нарешті знайшов хороше рішення для цього у списку розсилки розробників :

У поданні додайте:

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 (та формалізації API Model _meta API) я подумав, що оновлю це ще більш свіжою відповіддю.

Припускаючи ту ж модель:

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

Джанго <= 1,7

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:

Модель _metaAPI завжди існувала як Джанго внутрішнє, але формально не документована і підтримується. У рамках зусиль щодо оприлюднення цього API деякі з уже існуючих вхідних точок API незначно змінилися. Для перетворення вашого коду для використання нового офіційного API надано посібник з міграції.

У наведеному нижче прикладі ми використаємо формалізований метод для отримання всіх польових екземплярів моделі за допомогою 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 модельного поля, а також використовувати метод значення для отримання значення:

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.'}]

Можна використовувати values()метод a queryset, який повертає словник. Далі цей метод приймає список полів, до яких слід підмножитися. values()Метод не буде працювати з get(), так що ви повинні використовувати filter()(зверніться до API QuerySet ).

В 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]

У detail.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 %}

Я використав https://stackoverflow.com/a/3431104/2022534, але замінив модель Django 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

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

Ви можете мати форму, яка робить роботу за вас.

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>

Дійсно повинен бути вбудований спосіб для цього. Я написав цю утиліту, build_pretty_data_viewяка приймає об'єкт моделі та екземпляр форми (форма на основі вашої моделі) і повертає aSortedDict .

Переваги цього рішення включають:

• Він зберігає порядок, використовуючи вбудований Django SortedDict.
• Коли намагається отримати label / verbose_name, але повертається до імені поля, якщо його не визначено.
• Він також необов'язково візьме exclude()список імен полів для виключення певних полів.
• Якщо ваш клас класу містить a 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 %}

Щасти. Сподіваюся, це допоможе комусь!

Нижче моє, натхнене шакерами get_all_fields . Він отримує дикт одного екземпляра моделі, якщо зустріти поле відношення, то призначте значення поля диктату рекурсивно.

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)

Замість редагування кожної моделі я рекомендував би написати один тег шаблону, який поверне все поле будь-якої заданої моделі .
Кожен об’єкт має список полів ._meta.fields.
Кожен польовий об’єкт має атрибутname який повертає його ім'я та метод, value_to_string()що постачається разом із вашою моделлю object, повертає його значення.
Решта така ж проста, як сказано в документації про Джанго .

Ось мій приклад того, як може виглядати цей тег шаблонів:

    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, щоб перетворити екземпляр моделі у форму.

Клас Form має багато більше інформації всередині, що дуже легко повторити, і це послужить тій самій цілі за рахунок трохи більше накладних витрат. Якщо ваші розміри набору відносно невеликі, я думаю, що вплив на продуктивність буде незначним.

Одним плюсом, крім зручності, звичайно, є те, що ви можете легко перетворити таблицю в редаговану сітку даних на більш пізній час.

Я придумав наступний метод, який працює для мене, оскільки в кожному випадку модель матиме пов'язаний з ним 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__модель
view.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}}, але всі таблиці мають вигляд даних, а не форми.

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

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 django, щоб поміняти віджети за замовчуванням на версії, які читаються лише:

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-etc . Він має model_field_verbose_nameтег шаблону, щоб отримати назву багатослівного поля з шаблонів: http://django-etc.rtfd.org/en/latest/models.html#model-field-template-tags

Я щойно тестував щось подібне на оболонці і, здається, робив свою роботу:

my_object_mapped = {attr.name: str(getattr(my_object, attr.name)) for attr in MyModel._meta.fields}

Зауважте, що якщо ви хочете подати str () для сторонніх об'єктів, вам слід визначити його у методі str . З цього ви маєте вислів значень для об'єкта. Тоді ви можете надати якийсь шаблон або будь-який інший.

Джанго> = 2,0

Додати get_fields()до свого 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]

Потім зателефонуйте, як object.get_fieldsна своєму template.html:

<table>
    {% for label, value in object.get_fields %}
        <tr>
            <td>{{ label }}</td>
            <td>{{ value }}</td>
        </tr>
    {% endfor %}
</table>