How to print an object in Python

Question:

I have a dictionary like:

{'string': u'abc', 'object': <DEMO.Detail object at 0xb5b691ac>}

How can I make it show the contents of the DEMO.Detail object‘s __dict__, like so?

{'string': u'abc', 'object': {'obj_string': u'xyz', 'obj_object': {...}}}
Asked By: Weil

||

Answers:

Could prettyprint do it?

>>> import pprint
>>> a = {'foo':{'bar':'yeah'}}
>>> pprint.pprint(a)
{'foo': {'bar': 'yeah'}}

If your objects have __repr__ implemented, it can also print those.

import pprint
class Cheetah:
    def __repr__(self):
        return "chirp"

zoo = {'cage':{'animal':Cheetah()}}
pprint.pprint(zoo) 

# Output: {'cage': {'animal': chirp}}
Answered By: Bemmu

If you are the creator of DEMO.Detail, you could add __repr__ and __str__ methods:

class Detail:
    def __str__(self):
        return "string shown to users (on str and print)"
    def __repr__(self):
        return "string shown to developers (at REPL)"

This will cause your object to function this way:

>>> d = Detail()
>>> d
string shown to developers (at REPL)
>>> print(d)
string shown to users (on str and print)

In your case I assume you’ll want to call dict(self) inside __str__.

If you do not control the object, you could setup a recursive printing function that checks whether the object is of a known container type (list, tuple, dict, set) and recursively calls iterates through these types, printing all of your custom types as appropriate.

There should be a way to override pprint with a custom PrettyPrinter. I’ve never done this though.

Lastly, you could also make a custom JSONEncoder that understands your custom types. This wouldn’t be a good solution unless you actually need a JSON format.

Answered By: Trey Hunner
Categories: questions Tags:
Answers are sorted by their score. The answer accepted by the question owner as the best is marked with
at the top-right corner.