How can I get access to a Django Model field verbose name dynamically?

Question

I'd like to have access to one my model field verbose_name.

I can get it by the field indice like this

model._meta._fields()[2].verbose_name

but I need to get it dynamically. Ideally it would be something like this

model._meta._fields()['location_x'].verbose_name

I've looked at a few things but I just can't find it.

score 49 · Accepted Answer · edited Oct 24 '17 at 10:03

49

For Django < 1.10:

model._meta.get_field_by_name('location_x')[0].verbose_name

edited Oct 24 '17 at 10:03

gdvalderrama

713
1
17
26

answered Mar 11 '10 at 22:14

Ignacio Vazquez-Abrams

776,304
153
1,341
1,358

I get `'str' object has no attribute '_meta'` error. Django 1.7. – Mikhail Batcer Nov 13 '14 at 07:33
5

@MikhailBatcer: I don't know how to break this to you, but... strings don't have fields. – Ignacio Vazquez-Abrams Nov 13 '14 at 07:39
Well, it's model object which is passed in your snippet, and not string, isn't it? – Mikhail Batcer Nov 13 '14 at 07:44
Yes, which means that you need to pass a model too. – Ignacio Vazquez-Abrams Nov 13 '14 at 07:45
2

Well, and I do, I have template filter for that: `def verbose_name(value, arg): return value._meta.get_field_by_name(arg)[0].verbose_name` and in template: `{{ book|verbose_name:"title" }}` – Mikhail Batcer Nov 13 '14 at 07:47
How have you registered the filter? – Ignacio Vazquez-Abrams Nov 13 '14 at 07:53
Prepending `def verbose_name` with the decorator `@register.filter` – Mikhail Batcer Nov 13 '14 at 08:56
2

The `get_field_by_name` method was [removed for Django 1.10](https://docs.djangoproject.com/en/1.11/internals/deprecation/#deprecation-removed-in-1-10), plus using `get_field` suggested below looks less of a hack... – DrBuck Jun 29 '17 at 07:29

score 30 · Answer 2 · answered Jan 28 '14 at 13:00

30

model._meta.get_field('location_x').verbose_name

answered Jan 28 '14 at 13:00

Bertrand Bordage

921
9
16

score 20 · Answer 3 · answered Nov 17 '17 at 16:52

20

For Django 1.11 and 2.0:

MyModel._meta.get_field('my_field_name').verbose_name

More info in the Django doc

answered Nov 17 '17 at 16:52

renno

2,659
2
27
58

Nithish · Answer 4 · 2017-11-21T06:58:16.153

The selected answer gives a proxy object which might look as below.

<django.utils.functional.__proxy__ object at 0x{SomeMemoryLocation}>

If anyone is seeing the same, you can find the string for the verbose name in the title() member function of the proxy object.

model._meta.get_field_by_name(header)[0].verbose_name.title()

A better way to write this would be:

model._meta.get_field(header).verbose_name.title()

where header will be the name of the field you are interested in. i.e., 'location-x' in OPs context.

NOTE: Developers of Django also feel that using get_field is better and thus have depreciated get_field_by_name in Django 1.10. Thus I would suggest using get_field no matter what version of Django you use.

score 7 · Answer 5 · edited Apr 02 '15 at 21:42

7

model._meta.get_field_by_name('location_x')[0].verbose_name

edited Apr 02 '15 at 21:42

Ozgur Vatansever

49,246
17
84
119

answered Mar 11 '10 at 22:15

Dmitry Shevchenko

31,814
10
56
62

Alvaro Rodriguez Scelza · Answer 6 · 2021-04-22T00:42:47.337

5

You can also use:

Model.location_x.field.verbose_name

Model being the class name. I tested this on my Animal model:

Animal.sale_price.field.verbose_name

Animal.sale_price returns a DeferredAttribute, which has several meta data, like the verbose_name

Note: I'm using Django 3.1.5

edited Apr 22 '21 at 00:42

answered Apr 22 '21 at 00:23

Alvaro Rodriguez Scelza

3,643
2
32
47

arianvc · Answer 7 · 2018-11-14T12:08:44.197

2

If you want to iterate on all the fields you need to get the field:

for f in BotUser._meta.get_fields():
    if hasattr(f, 'verbose_name'):
        print(f.verbose_name)

edited Nov 14 '18 at 12:08

answered Nov 12 '18 at 12:18

arianvc

101
10

1

Kudos. This is better than most solutions here! No beating around the bush (no need to specify any `field`). And is dynamic. – carla Nov 28 '22 at 13:49

freelance · Answer 8 · 2021-10-04T09:20:15.613

# select fields for bulk_update : exclude primary key and relational
fieldsfields_to_update = []
for field_to_update in Model._meta.get_fields():
        if not field_to_update.many_to_many and not field_to_update.many_to_one and not field_to_update.one_to_many and not field_to_update.one_to_one and not field_to_update.primary_key and not field_to_update.is_relation :
            fields_to_update = fields_to_update + [field_to_update.name]
Model.objects.bulk_update(models_to_update , fields_to_update)

How can I get access to a Django Model field verbose name dynamically?

8 Answers8

Linked