45. Python Essentials: Overriding the Print Method in Python Classes

Screenshot from the tutorial

Python Essentials: Overriding the Print Method in Python Classes

In the world of Python, classes and objects are fundamental concepts that allow for the creation of complex data structures. One of the powerful features of classes is the ability to override built-in methods, including the __str__ and __repr__ methods, which directly influence how objects are printed. In this blog post, we will explore how to override the print method in Python classes, enhancing the way we represent our objects when printed.

Understanding the __str__ and __repr__ Methods

Before diving into overriding methods, it’s essential to understand the purpose of the __str__ and __repr__ methods:

• __str__ Method: This method is intended to return a "pretty" or user-friendly string representation of an object. It is called by the print() function and str().

• __repr__ Method: This method is meant to return an "official" string representation of the object that ideally could be used to recreate the object. It is called by the built-in repr() function and is also used in interactive sessions.

By overriding these methods, you can control how your objects are displayed when printed or when viewed in a console.

Overriding the Print Method: A Step-by-Step Guide

Let's walk through an example of how to override these methods in a custom class.

Step 1: Creating a Custom Class

First, let’s create a simple class that represents a Car. This class will have attributes like make, model, and year.

class Car:
    def __init__(self, make, model, year):
        self.make = make
        self.model = model
        self.year = year

Step 2: Overriding the __str__ Method

Next, we will implement the __str__ method to provide a user-friendly string representation of the Car object.

    def __str__(self):
        return f"{self.year} {self.make} {self.model}"

Step 3: Overriding the __repr__ Method

Now, let's implement the __repr__ method, which will provide a more technical representation of the Car object.

    def __repr__(self):
        return f"Car(make='{self.make}', model='{self.model}', year={self.year})"

Step 4: Putting It All Together

Now that we have defined our methods, let's combine everything in our Car class:

class Car:
    def __init__(self, make, model, year):
        self.make = make
        self.model = model
        self.year = year

    def __str__(self):
        return f"{self.year} {self.make} {self.model}"

    def __repr__(self):
        return f"Car(make='{self.make}', model='{self.model}', year={self.year})"

Step 5: Testing the Overridden Methods

Now, let’s create an instance of the Car class and see how our overridden methods work in practice.

my_car = Car('Toyota', 'Camry', 2022)

# Using print(), which calls __str__()
print(my_car)  # Output: 2022 Toyota Camry

# Using repr(), which calls __repr__()
print(repr(my_car))  # Output: Car(make='Toyota', model='Camry', year=2022)

Conclusion

Overriding the print methods in Python classes allows you to control how your objects are represented when printed. By implementing the __str__ and __repr__ methods, you create meaningful and informative outputs that can enhance the readability of your code.

This capability is particularly useful for debugging and logging, as it provides clear insights into the state of your objects. Remember that while __str__ is for end-users, __repr__ is aimed at developers. Understanding the distinction can significantly improve how you design your classes in Python.

Feel free to experiment with your own classes and override these methods to see how they change the output. Happy coding!

Another view from the tutorial

---

Connect with SkillBakery Studios

Explore more tutorials, tools, and resources:

• skillbakery.com
• Facebook
• X (Twitter)
• YouTube Channel

Posted by SkillBakery Studios