Введение в магические методы

Магические методы, также известные как методы с двойным подчёркиванием (сокращённо — «двойное подчёркивание»), — это специальные методы в Python, позволяющие определять поведение объектов в определённых ситуациях.

В этом уроке Вы узнаете, как использовать распространённые магические методы, такие как __str__, __repr__ и другие.

Что такое магические методы

Магические методы — это заранее определённые методы в Python, которые автоматически вызываются при выполнении определённых операций над объектами. Их можно распознать по двум символам подчёркивания, например в __init__ или __str__.

Метод __init__

Метод __init__ — это конструктор, который инициализирует новый объект. Он автоматически вызывается при создании объекта:

# Using the __init__ method to initialize attributes
class Person:
    def __init__(self, name, age):
        self.name = name  # Initialize the name attribute
        self.age = age  # Initialize the age attribute

# Creating an instance of Person
person = Person("Alice", 30)
print(person.name, person.age)  # Outputs: Alice 30

Метод __str__

Метод __str__ определяет строковое представление объекта при вызове print():

# Defining the __str__ method
class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

    def __str__(self):
        return f"Name: {self.name}, Age: {self.age}"  # String representation

person = Person("Alice", 30)
print(person)  # Outputs: Name: Alice, Age: 30

Метод __repr__

Метод __repr__ предоставляет официальное строковое представление объекта, которое часто используется для отладки:

# Defining the __repr__ method
class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

    def __repr__(self):
        return f"Person('{self.name}', {self.age})"  # Debug-friendly representation

person = Person("Alice", 30)
print(repr(person))  # Outputs: Person('Alice', 30)

Перегрузка операторов с помощью магических методов

Вы можете использовать магические методы, чтобы настроить поведение операторов, таких как + или ==:

# Overloading the + operator with __add__
class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y

    def __add__(self, other):
        return Point(self.x + other.x, self.y + other.y)  # Adding two points

    def __str__(self):
        return f"({self.x}, {self.y})"

point1 = Point(1, 2)
point2 = Point(3, 4)
result = point1 + point2  # Calls __add__
print(result)  # Outputs: (4, 6)

Распространённые магические методы

Вот некоторые часто используемые магические методы:

• __len__: определяет поведение функции len().
• __getitem__: позволяет обращаться к элементам по индексу, как в списке или словаре.
• __eq__: настраивает сравнение на равенство с помощью ==.

Использование __len__ и __getitem__

Вы можете использовать __len__, чтобы определить длину пользовательского объекта, а __getitem__ — чтобы сделать его доступным по индексу:

# Using __len__ and __getitem__ in a custom class
class CustomList:
    def __init__(self, items):
        self.items = items

    def __len__(self):
        return len(self.items)  # Defines the behavior of len()

    def __getitem__(self, index):
        return self.items[index]  # Enables indexing

custom_list = CustomList([1, 2, 3])
print(len(custom_list))  # Outputs: 3
print(custom_list[1])  # Outputs: 2

Распространённые ошибки при работе с магическими методами

Вот некоторые ошибки, которых следует избегать:

• Определение магического метода без соответствия его предполагаемому поведению.
• Перегрузка операторов без необходимости.
• Не выполнять implementing всех требуемых магических методов в пользовательских типах данных.

Что мы узнали

В этом уроке Вы узнали:

• Что такое магические методы и чем они полезны.
• Как использовать распространённые магические методы, такие как __init__, __str__ и __repr__.
• Как перегружать операторы с помощью магических методов.

Отличная работа! Перейдём к следующей теме.