Comparison magic methods in Python - Mini Project: Build & Apply

Comparison Magic Methods

📖 Scenario: Imagine you are creating a simple program to compare books by their number of pages. You want to be able to say if one book is shorter, longer, or the same length as another book.

🎯 Goal: You will build a Book class that can compare two books using comparison operators like <, >, and ==. This will help you easily check which book is longer or if they have the same length.

📋 What You'll Learn

Create a Book class with a title and pages attributes

Add a variable called book1 with title 'Python Basics' and 150 pages

Add a variable called book2 with title 'Advanced Python' and 200 pages

Add a variable called book3 with title 'Python Basics' and 150 pages

Implement the __lt__ method to compare books by pages

Implement the __eq__ method to check if two books have the same pages

Print the results of book1 < book2 and book1 == book3

💡 Why This Matters

🌍 Real World

Comparison magic methods let you compare custom objects easily, like sorting products by price or comparing students by grades.

💼 Career

Understanding these methods is useful for software development jobs where you create classes that need to be compared or sorted, such as in data processing or game development.

1

Create the Book class and book variables

Create a class called Book with an __init__ method that takes title and pages as parameters and stores them as attributes. Then create three variables: book1 with title 'Python Basics' and 150 pages, book2 with title 'Advanced Python' and 200 pages, and book3 with title 'Python Basics' and 150 pages.

Python

# Your code here

Hint

Remember to define the __init__ method inside the Book class and assign the parameters to self.title and self.pages. Then create the three book variables exactly as described.

2

Add the __lt__ method to compare books by pages

Inside the Book class, add a method called __lt__ that takes self and other as parameters. It should return True if self.pages is less than other.pages, otherwise False.

Python

class Book:
    def __init__(self, title, pages):
        self.title = title
        self.pages = pages

    # Add __lt__ method here

book1 = Book('Python Basics', 150)
book2 = Book('Advanced Python', 200)
book3 = Book('Python Basics', 150)

Hint

The __lt__ method is called when you use the < operator. It should compare the pages attribute of self and other.

3

Add the __eq__ method to check if books have the same pages

Inside the Book class, add a method called __eq__ that takes self and other as parameters. It should return True if self.pages is equal to other.pages, otherwise False.

Python

class Book:
    def __init__(self, title, pages):
        self.title = title
        self.pages = pages

    def __lt__(self, other):
        return self.pages < other.pages

    # Add __eq__ method here

book1 = Book('Python Basics', 150)
book2 = Book('Advanced Python', 200)
book3 = Book('Python Basics', 150)

Hint

The __eq__ method is called when you use the == operator. It should compare the pages attribute of self and other.

4

Print comparison results between book1 and book2

Write two print statements: one that prints the result of book1 < book2 and another that prints the result of book1 == book3.

Python

class Book:
    def __init__(self, title, pages):
        self.title = title
        self.pages = pages

    def __lt__(self, other):
        return self.pages < other.pages

    def __eq__(self, other):
        return self.pages == other.pages

book1 = Book('Python Basics', 150)
book2 = Book('Advanced Python', 200)
book3 = Book('Python Basics', 150)

# Print comparison results below
# Your code here

Hint

Use print(book1 < book2) and print(book1 == book3) to show the comparison results.

Practice

1. Which magic method in Python is used to define the behavior of the equality operator ==?

easy

A. __eq__

B. __lt__

C. __ne__

D. __gt__

Solution

1. Step 1: Understand the equality operator

   The == operator checks if two objects are equal.

2. Step 2: Identify the corresponding magic method

   In Python, __eq__ is the method that defines equality behavior.

3. Final Answer:

   __eq__ -> Option A

4. Quick Check:

   Equality operator uses __eq__ [OK]

Hint: Remember: eq means equal, so __eq__ handles == [OK]

Common Mistakes:

• Confusing __eq__ with __lt__ or __gt__
• Thinking __ne__ handles equality
• Mixing up method names with comparison operators

2. Which of the following is the correct syntax to define the less than operator < in a Python class?

easy

A. def __lt__(self):

B. def __less_than__(self, other):

C. def __less__(self, other):

D. def __lt__(self, other):

Solution

1. Step 1: Recall the magic method name for <

   The method for < is __lt__ and it takes two parameters: self and other.

2. Step 2: Check method signature correctness

   Correct syntax is def __lt__(self, other):. Other options have wrong names or missing parameters.

3. Final Answer:

   def __lt__(self, other): -> Option D

4. Quick Check:

   Less than operator uses __lt__(self, other) [OK]

Hint: Magic methods for comparisons always take self and other [OK]

Common Mistakes:

• Using wrong method names like __less_than__
• Omitting the other parameter
• Using incorrect method signatures

3. What will be the output of the following code?

class Number:
    def __init__(self, value):
        self.value = value
    def __gt__(self, other):
        return self.value > other.value

n1 = Number(5)
n2 = Number(3)
print(n1 > n2)

medium

A. False

B. TypeError

C. True

D. None

Solution

1. Step 1: Understand the __gt__ method

   The __gt__ method compares self.value and other.value.

2. Step 2: Evaluate the comparison

   n1.value is 5 and n2.value is 3, so 5 > 3 is True.

3. Final Answer:

   True -> Option C

4. Quick Check:

   5 > 3 = True [OK]

Hint: Check the values inside objects when comparing [OK]

Common Mistakes:

• Forgetting to compare attributes inside objects
• Expecting print to show object addresses
• Confusing __gt__ with __lt__

4. Identify the error in the following class that tries to implement the not equal operator !=:

class Item:
    def __init__(self, val):
        self.val = val
    def __ne__(self):
        return self.val != other.val

medium

A. The class should inherit from object explicitly

B. __ne__ method is missing the other parameter

C. The __ne__ method should return True always

D. The __init__ method is missing self

Solution

1. Step 1: Check __ne__ method signature

   The __ne__ method must take two parameters: self and other.

2. Step 2: Identify missing parameter

   Here, other is used but not declared as a parameter, causing an error.

3. Final Answer:

   __ne__ method is missing the other parameter -> Option B

4. Quick Check:

   __ne__ needs (self, other) parameters [OK]

Hint: Comparison methods always take self and other [OK]

Common Mistakes:

• Omitting the other parameter in comparison methods
• Misunderstanding method signatures
• Thinking inheritance from object is required in Python 3

5. You want to create a class Box where two boxes are considered equal if their volumes are equal. Which magic method should you implement and how?

class Box:
    def __init__(self, length, width, height):
        self.length = length
        self.width = width
        self.height = height
    # Your code here

hard

A. Implement __eq__(self, other) to compare volumes: return self.length * self.width * self.height == other.length * other.width * other.height

B. Implement __lt__(self, other) to compare volumes

C. Implement __ne__(self, other) to compare volumes

D. Implement __gt__(self, other) to compare volumes

Solution

1. Step 1: Identify the comparison needed

   Equality means using ==, so implement __eq__.

2. Step 2: Define volume comparison inside __eq__

   Calculate volume for both boxes and compare for equality.

3. Final Answer:

   Implement __eq__(self, other) to compare volumes: return self.length * self.width * self.height == other.length * other.width * other.height -> Option A

4. Quick Check:

   Equality uses __eq__ comparing volumes [OK]

Hint: Use __eq__ to define equality based on volume [OK]

Common Mistakes:

• Using __lt__ or __gt__ for equality
• Not comparing volumes but attributes directly
• Forgetting to implement __eq__ for == operator