Python/Django debugging: print model's containing data

Question

Maybe easy question but I don't know how to summarize it that I would find my answer.

Is it possible to print out all available fields of model?

For example in iPython I can import model and just write model name and tab will show all available fields the models have.

Is it possible to do this in code without using some sort of shell?

I would like to use some sort of command (e.a. print_fields(self)) and get what's inside the model.

Are you just wanted to know the field names or the data in the fields as well? — Bryce Siedschlaw, May 31 '11 at 15:53
@Bryce Siedschlaw: fields is enough :) thats for help, i got my answer — JackLeo, May 31 '11 at 16:01
See also http://stackoverflow.com/questions/3106295/django-get-list-of-model-fields — Risadinha, Mar 03 '17 at 16:42

score 24 · Answer 1 · edited May 23 '17 at 12:09

24

If you have the model instance(s) you can simply call:

model_queryset.all().values()

https://docs.djangoproject.com/en/dev/ref/models/querysets/#django.db.models.query.QuerySet.values

For just the list of fields using the model class itself see Django: Get list of model fields?

or directly the documentation - for Django 1.10 there is a dedicated section on how to work with fields: https://docs.djangoproject.com/en/1.10/ref/models/meta/#retrieving-all-field-instances-of-a-model

edited May 23 '17 at 12:09

Community

1
1

answered Aug 18 '14 at 13:40

Risadinha

16,058
2
88
91

even a complete trace of a single object. awesome – Evhz Mar 02 '17 at 23:39
^^^^ this is what you are looking for if you want to see inside a queryset without a loop – nurettin Nov 29 '22 at 14:47

Zach Kelling · Accepted Answer · 2011-05-31T15:57:51.020

24

To check fields on a model I usually use ?:

>>> Person?
Type:       ModelBase
Base Class: <class 'django.db.models.base.ModelBase'>
String Form:    <class 'foo.bar.models.Person'>
Namespace:  Interactive
File:       /home/zk/ve/django/foo/bar/models.py
Docstring:
    Person(id, first_name, last_name)

You can also use help(). If you have an instance of the model you can look at __dict__:

>>> [x for x in Person().__dict__.keys() if not x.startswith('_')]
<<< ['first_name', 'last_name', 'id']

edited May 31 '11 at 15:57

answered May 31 '11 at 15:51

Zach Kelling

52,505
13
109
108

help() trowed all i needed :) so simple... damn i'm stupid :D oh, `?` works only in shell. – JackLeo May 31 '11 at 16:00
Oh good point, I misread and thought you were asking how to check in IPython! – Zach Kelling May 31 '11 at 16:01

score 11 · Answer 3 · answered May 31 '11 at 15:54

11

I think you just want to use __dict__ on an instance of a model. (It won't give methods like tab completion in ipython though). Also using __doc__ is quite helpful usually.

Also look into inspect http://docs.python.org/library/inspect.html

answered May 31 '11 at 15:54

dr jimbob

17,259
7
59
81

score 4 · Answer 4 · edited May 23 '17 at 12:02

4

Maybe try something suggested here:

data = serializers.serialize("json", models.MyModel.objects.all(), indent=4)

JSON format is easy to print and read ;)

edited May 23 '17 at 12:02

Community

1
1

answered May 31 '11 at 15:51

Grzegorz Rożniecki

27,415
11
90
112

score 1 · Answer 5 · answered Jun 09 '21 at 11:27

1

Inspired by @zeekay's answer, use the following to see the fields and corresponding values for an instance of a model:

[x for x in Cheese.objects.all()[0].__dict__.items() if not x[0].startswith('_')]

answered Jun 09 '21 at 11:27

Rami Elwan

106
1
6

score -1 · Answer 6 · answered May 31 '11 at 15:50

-1

Why don't you implement __unicode__ :

def __unicode__(self):
    return self.whatever_field + self.another_field

answered May 31 '11 at 15:50

Geo

93,257
117
344
520

1

because i don't know what the fields are? Thats my main problem. – JackLeo May 31 '11 at 15:52

Python/Django debugging: print model's containing data

6 Answers6