{"id":179,"date":"2024-11-17T10:00:00","date_gmt":"2024-11-17T16:00:00","guid":{"rendered":"https:\/\/douglasstarnes.dev\/?p=179"},"modified":"2024-11-14T20:56:23","modified_gmt":"2024-11-15T02:56:23","slug":"__str__-vs-__repr__","status":"publish","type":"post","link":"https:\/\/douglasstarnes.dev\/index.php\/2024\/11\/17\/__str__-vs-__repr__\/","title":{"rendered":"__str__ vs. __repr__"},"content":{"rendered":"\n

Classes in Python has a number of built-in features that you can customize. These features are accessible through methods defined by Python itself. Often, these methods are surrounded by two underscores, or a double underscore. Thus such a method is sometimes referred to as a “dunder method”.<\/p>\n\n\n\n

Two of these “dunder methods”, __str__<\/code> and __repr__ <\/code>let you customize the string representations of an object. In this post, you’ll see how to override the __str__ <\/code>and __repr__ <\/code>methods and more about their use cases. But first, we’ll need a class.<\/p>\n\n\n\n

<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
class<\/span> <\/span>TodoItem<\/span>:<\/span><\/span>\n  <\/span>def<\/span> <\/span>__init__<\/span>(<\/span>self<\/span>,<\/span> <\/span>task<\/span>,<\/span> <\/span>priority<\/span>=<\/span>0<\/span>,<\/span> <\/span>complete<\/span>=False<\/span>):<\/span><\/span>\n    <\/span>self<\/span>.<\/span>task <\/span>=<\/span> task<\/span><\/span>\n    <\/span>self<\/span>.<\/span>priority <\/span>=<\/span> priority<\/span><\/span>\n    <\/span>self<\/span>.<\/span>complete <\/span>=<\/span> complete<\/span><\/span>\n    <\/span><\/span>\n  <\/span>def<\/span> <\/span>set_complete<\/span>(<\/span>self<\/span>):<\/span><\/span>\n    <\/span>self<\/span>.<\/span>complete <\/span>=<\/span> <\/span>True<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Now let’s create an instance of the TodoItem class (an object) and print it to the console.<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
if<\/span> __name__ <\/span>==<\/span> <\/span>"<\/span>__main__<\/span>"<\/span>:<\/span><\/span>\n  my_next_task <\/span>=<\/span> <\/span>TodoItem<\/span>(<\/span>"<\/span>My next task<\/span>"<\/span>)<\/span><\/span>\n  <\/span>print<\/span>(<\/span>my_next_task<\/span>)<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Here is the result on my machine:<\/p>\n\n\n\n
<__main__.TodoItem object at 0x7f02a442d1d0><\/code><\/p>\n\n\n\n
Not very useful.  This simply say that my_next_task <\/code>is an object of type TodoItem <\/code>in the __main__ <\/code>module at this memory address.  Again the memory address on your machine will be different.<\/p>\n\n\n\n
To make this a little more useful, let’s override the __repr__ (pronounced “dunder repper”) method to return the values of the attribute of the object.<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
class<\/span> <\/span>TodoItem<\/span>:<\/span><\/span>\n  <\/span># existing code<\/span><\/span>\n  <\/span>def<\/span> <\/span>__repr__<\/span>(<\/span>self<\/span>):<\/span><\/span>\n    is_complete <\/span>=<\/span> <\/span>"<\/span>not complete<\/span>"<\/span> <\/span>if<\/span> <\/span>not<\/span> <\/span>self<\/span>.<\/span>complete <\/span>else<\/span> <\/span>"<\/span>complete<\/span>"<\/span><\/span>\n    <\/span>return<\/span> <\/span>f<\/span>"<TodoItem task='<\/span>{<\/span>self<\/span>.<\/span>task<\/span>}<\/span>', priority=<\/span>{<\/span>self<\/span>.<\/span>priority<\/span>}<\/span>, <\/span>{<\/span>is_complete<\/span>}<\/span>>"<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Run the app again and you’ll see this:<\/p>\n\n\n\n
<TodoItem task='My next task', priority=0, not complete><\/code><\/pre>\n\n\n\n
This is indeed more useful.  It appears when you display the value of an object with the print<\/code> function, behind the scenes, Python calls the __repr__ <\/code>method of the object and displays the return value.<\/p>\n\n\n\n
But what does the __str__ method do?  Let’s add one and find out.<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
class<\/span> <\/span>TodoItem<\/span>:<\/span><\/span>\n  <\/span># existing code<\/span><\/span>\n  <\/span>def<\/span> <\/span>__str__<\/span>(<\/span>self<\/span>):<\/span><\/span>\n    is_complete <\/span>=<\/span> <\/span>"<\/span>not complete<\/span>"<\/span> <\/span>if<\/span> <\/span>not<\/span> <\/span>self<\/span>.<\/span>complete <\/span>else<\/span> <\/span>"<\/span>complete<\/span>"<\/span><\/span>\n    <\/span>return<\/span> <\/span>f<\/span>"TodoItem(task='<\/span>{<\/span>self<\/span>.<\/span>task<\/span>}<\/span>', priority=<\/span>{<\/span>self<\/span>.<\/span>priority<\/span>}<\/span>, <\/span>{<\/span>is_complete<\/span>}<\/span>)"<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Now run the app again.<\/p>\n\n\n\n
TodoItem(task='My next task', priority=0, not complete)<\/code><\/pre>\n\n\n\n
Now it looks like when using the print <\/code>function, the default behavior is to call the __str__ <\/code>method, and output the return value to the console.  But if there is not __str__ <\/code>method override, use the __repr__ <\/code>method.  And if there is no __repr__ <\/code>method, use the default representation with the type and memory location.<\/p>\n\n\n\n
So what is the intended use of the __repr__ <\/code>method other than a fallback when there is no __str__ <\/code>override?  To answer that question, we’ll need to open an interactive prompt or REPL such as IPython.  At the prompt, import the TodoItem <\/code>class.  Create a new instance.  Then get the value, but don’t use the print <\/code>function.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Now we can see the intended use of the __repr__ <\/code>function.  It’s the default for getting the string representation of an object in the REPL.  However, you can still use the print function and get the __str__ <\/code>representation as well:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
The __str__ <\/code>representation will also be used if you call the str <\/code>initializer.<\/p>\n\n\n\n
In this example, we used string representations that were just different enough to tell which function they came from.  But in the real world, what data should each one display?<\/p>\n\n\n\n
If you think about it, you’re not going to have that many end users inspecting your code through an interactive REPL.  Therefore, this is a use case for more technical users who are going to be looking for more technical information.  And that is what should be displayed by the __repr__ <\/code>method.  But end users are going to want to see a more friendly string representation and in that case the __str__ <\/code>method should be used.<\/p>\n\n\n\n
Summary<\/h2>\n\n\n\n
In this post you saw the difference between the __str__ <\/code>and __repr__ <\/code>methods.  The __str__ <\/code>method is called when getting the string representation of an object via the print function or str initializer.  It is intended to be friendly and consumed by end users.  Technical users will be using tools like an interactive REPL and expect technical details in the string representation.  This is when Python defaults to the __repr__ <\/code>method string representation.  There is also a default Python string representation that displays the type of the object and it’s memory address.<\/p>\n\n\n\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
Classes in Python has a number of built-in features that you can customize. These features…<\/p>\n","protected":false},"author":1,"featured_media":185,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[18],"tags":[19,4],"class_list":["post-179","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-python","tag-oop","tag-python"],"_links":{"self":[{"href":"https:\/\/douglasstarnes.dev\/index.php\/wp-json\/wp\/v2\/posts\/179","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/douglasstarnes.dev\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/douglasstarnes.dev\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/douglasstarnes.dev\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/douglasstarnes.dev\/index.php\/wp-json\/wp\/v2\/comments?post=179"}],"version-history":[{"count":3,"href":"https:\/\/douglasstarnes.dev\/index.php\/wp-json\/wp\/v2\/posts\/179\/revisions"}],"predecessor-version":[{"id":184,"href":"https:\/\/douglasstarnes.dev\/index.php\/wp-json\/wp\/v2\/posts\/179\/revisions\/184"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/douglasstarnes.dev\/index.php\/wp-json\/wp\/v2\/media\/185"}],"wp:attachment":[{"href":"https:\/\/douglasstarnes.dev\/index.php\/wp-json\/wp\/v2\/media?parent=179"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/douglasstarnes.dev\/index.php\/wp-json\/wp\/v2\/categories?post=179"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/douglasstarnes.dev\/index.php\/wp-json\/wp\/v2\/tags?post=179"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}