Магические методы в Python
В этой статье объясняются магические методы в Python.
YouTube Video
Магические методы в Python
Магические методы (специальные методы) в Python — это методы с особым именованием, которые используются для придания классам уникального поведения. Например, их отличительной особенностью является то, что они заключены в двойные подчёркивания (danders), как __init__ и __str__. Поэтому их также называют «ду́ндер-методами» (от double underscore).
Определяя магические методы, вы можете настраивать стандартное поведение классов. Например, определив __add__, вы можете изменить поведение оператора +.
Магические методы для инициализации и строкового представления
__init__: Метод инициализации
Метод __init__ — это конструктор, который автоматически вызывается при создании экземпляра класса.
1class Person:
2 def __init__(self, name, age):
3 self.name = name
4 self.age = age
5
6person = Person("Alice", 30)
7print(person.name) # Alice__str__: Читаемое строковое представление
Метод __str__ возвращает читаемое строковое представление объекта. Он вызывается функциями print() и str().
1class Person:
2 def __init__(self, name):
3 self.name = name
4
5 def __str__(self):
6 return f"Person: {self.name}"
7
8person = Person("Bob")
9print(person) # Person: Bob__repr__: Строковое представление для отладки
Метод __repr__ возвращает строковое представление объекта для целей отладки. Он используется функцией repr() и при отображении в интерактивном режиме интерпретатора.
1class Person:
2 def __init__(self, name):
3 self.name = name
4
5 def __repr__(self):
6 return f"Person(name={self.name!r})"
7
8person = Person("Eve")
9print(repr(person)) # Person(name='Eve')Перегрузка арифметических операторов
__add__: Оператор +
С помощью магических методов можно перегружать арифметические операторы. Например, метод __add__ позволяет перегрузить оператор +.
1class Vector:
2 def __init__(self, x, y):
3 self.x = x
4 self.y = y
5
6 def __add__(self, other):
7 return Vector(self.x + other.x, self.y + other.y)
8
9 def __repr__(self):
10 return f"Vector({self.x}, {self.y})"
11
12 # Other arithmetic magic methods:
13 # def __sub__(self, other): # Subtraction (-)
14 # def __mul__(self, other): # Multiplication (*)
15 # def __truediv__(self, other): # True division (/)
16 # def __floordiv__(self, other): # Floor division (//)
17 # def __mod__(self, other): # Modulo (%)
18 # def __pow__(self, other): # Exponentiation (**)
19
20v1 = Vector(1, 2)
21v2 = Vector(3, 4)
22print(v1 + v2) # Vector(4, 6)К другим арифметическим магическим методам относятся следующие:.
| Метод | Оператор |
|---|---|
__add__ |
+ |
__sub__ |
- |
__mul__ |
* |
__truediv__ |
/ |
__floordiv__ |
// |
__mod__ |
% |
__pow__ |
** |
Настройка операторов сравнения
Также можно перегружать операторы сравнения. Например, метод __eq__ перегружает оператор равенства.
1class Box:
2 def __init__(self, volume):
3 self.volume = volume
4
5 def __eq__(self, other):
6 return self.volume == other.volume
7
8 def __lt__(self, other):
9 return self.volume < other.volume
10
11 # Comparison magic methods:
12 # def __eq__(self, other): # Equal to (==)
13 # def __ne__(self, other): # Not equal to (!=)
14 # def __lt__(self, other): # Less than (<)
15 # def __le__(self, other): # Less than or equal to (<=)
16 # def __gt__(self, other): # Greater than (>)
17 # def __ge__(self, other): # Greater than or equal to (>=)
18
19b1 = Box(100)
20b2 = Box(200)
21
22print(b1 == b2) # False
23print(b1 < b2) # TrueТакже существуют следующие магические методы:. Эти магические методы определяют операции сравнения, такие как равенство и порядок между объектами.
| Оператор | Магический метод |
|---|---|
== |
__eq__ |
!= |
__ne__ |
< |
__lt__ |
<= |
__le__ |
> |
__gt__ |
>= |
__ge__ |
Магические методы для контейнерных типов
Вы можете создавать классы, которые ведут себя как списки или словари.
__len__: Получение числа элементов
Метод __len__ — это магический метод, возвращающий количество элементов.
1class Basket:
2 def __init__(self, items):
3 self.items = items
4
5 def __len__(self):
6 return len(self.items)
7
8basket = Basket(["apple", "banana"])
9print(len(basket)) # 2__getitem__: Доступ по индексу
Метод __getitem__ вызывается при обращении по индексу.
1class Basket:
2 def __init__(self, items):
3 self.items = items
4
5 def __getitem__(self, index):
6 return self.items[index]
7
8basket = Basket(["apple", "banana"])
9print(basket[1]) # banana__setitem__ и __delitem__: Запись и удаление
Методы __setitem__ и __delitem__ вызываются при записи или удалении элементов.
1class Basket:
2 def __init__(self, items):
3 self.items = items
4
5 def __setitem__(self, index, value):
6 self.items[index] = value
7
8 def __delitem__(self, index):
9 del self.items[index]
10
11basket = Basket(["apple", "banana"])
12basket[1] = "grape"
13del basket[0]
14print(basket.items) # ['grape']Магические методы для итерирования
Чтобы объект можно было итерировать в цикле for, реализуйте следующее:.
__iter__ и __next__
1class Counter:
2 def __init__(self, limit):
3 self.limit = limit
4 self.current = 0
5
6 def __iter__(self):
7 return self
8
9 def __next__(self):
10 if self.current >= self.limit:
11 raise StopIteration
12 self.current += 1
13 return self.current
14
15for num in Counter(3):
16 print(num)
17# Output:
18# 1
19# 2
20# 3Контекстный менеджер (оператор with)
Определив методы __enter__ и __exit__, вы можете реализовать подготовительные и завершающие действия для оператора with.
1class FileOpener:
2 def __init__(self, filename):
3 self.filename = filename
4
5 def __enter__(self):
6 self.file = open(self.filename, 'r')
7 return self.file
8
9 def __exit__(self, exc_type, exc_val, exc_tb):
10 self.file.close()
11
12with FileOpener("example.txt") as f:
13 content = f.read()
14 print(content)Объекты, вызываемые как функции: __call__
Определив метод __call__, вы можете сделать экземпляр класса вызываемым как функцию.
1class Greeter:
2 def __init__(self, greeting):
3 self.greeting = greeting
4
5 def __call__(self, name):
6 return f"{self.greeting}, {name}!"
7
8hello = Greeter("Hello")
9print(hello("Alice")) # Hello, Alice!Резюме
Магические методы в Python — это мощный способ добавить классам естественное и интуитивно понятное поведение. У каждого метода есть чёткое назначение, и при правильной реализации они позволяют писать более гибкий и «питоничный» код.
Магические методы служат своего рода «невидимым интерфейсом», определяющим, как объекты Python взаимодействуют и ведут себя за кулисами.
Вы можете следовать этой статье, используя Visual Studio Code на нашем YouTube-канале. Пожалуйста, также посмотрите наш YouTube-канал.