Как использовать python __repr__ ?

[

Когда следует использовать .__repr__() против .__str__() в Python?

![When Should You Use .repr() vs .str() in Whats-the-Difference_Watermarked.a96767464f75.jpg)

Автор: Stephen Gruppetta Дата: 22 марта 2023 г.

Одной из самых распространенных задач, которую выполняет компьютерная программа, является отображение данных. Программа часто отображает эту информацию пользователю программы. Однако программа также должна отображать информацию для программиста, разрабатывающего и поддерживающего ее. Информация, которой программисту необходимо о объекте, отличается от того, как программа должна отображать этот же объект для пользователя, и именно здесь вступают в силу .__repr__() против .__str__().

У объекта Python есть несколько специальных методов, которые обеспечивают определенное поведение. Существуют два похожих специальных метода, которые описывают объект с использованием строкового представления. Этими методами являются .__repr__() и .__str__(). Метод .__repr__() возвращает подробное описание для программиста, который нуждается в поддержке и отладке кода. Метод .__str__() возвращает упрощенное описание с информацией для пользователя программы.

Методы .__repr__() и .__str__() - это два из специальных методов, которые вы можете определить для любого класса. Они позволяют вам контролировать способ отображения программой объекта в нескольких общих формах вывода, таких как вывод из функции print(), форматированные строки и интерактивные среды.

В этом руководстве вы узнаете, как различать .__repr__() и .__str__() и как использовать эти специальные методы в определенных вами классах. Определение этих методов делает классы, которые вы пишете, более читаемыми и проще отлаживать и поддерживать. Так когда следует выбрать .__repr__() против . __str__ в Python?

Вкратце: используйте .__repr__() для программистов и . __str__() для пользователей

Специальные методы .__repr__() и .__str__() оба возвращают строковые представления объекта. Строковое представление - это строка, которая показывает информацию о объекте. Вы можете настроить эту информацию для разных аудиторий, таких как пользователи программы или ваши коллеги-программисты.

Как и с другими специальными методами с ведущими и завершающими двойными подчеркиваниями в их именах, вы можете определить эти методы для любого класса.

Причина наличия двух методов для отображения объекта заключается в том, что у них есть разные цели:

• .__repr__() предоставляет официальное строковое представление объекта, нацеленное на программиста.
• .__str__() предоставляет неформальное строковое представление объекта, нацеленное на пользователя.

Целевой аудиторией для строкового представления, возвращаемого .__repr__(), является программист, разрабатывающий и поддерживающий программу. В общем случае оно предоставляет подробную и однозначную информацию об объекте. Еще одно важное свойство официального строкового представления заключается в том, что программист обычно может использовать его для создания объекта, равного изначальному.

Метод .__str__() предоставляет строковое представление, нацеленное на пользователя программы, который не обязательно является программистом на Python. Следовательно, это представление позволяет любому пользователю понять основную информацию об объекте, без необходимости разбираться в деталях его внутренней реализации.

Как можно получить строковое представление объекта?

Существует несколько способов получить строковое представление объекта в Python:

1. С использованием функции str() или приведения объекта к типу str: str(obj).
2. С использованием функции repr() или приведения объекта к типу repr: repr(obj).
3. Через специальные методы .__str__() и .__repr__(), вызываемые непосредственно на объекте: obj.__str__() и obj.__repr__().

Следует ли определять .__repr__() и .__str__() в пользовательском классе?

Определение .__repr__() и .__str__() в пользовательском классе часто является хорошей практикой для улучшения читаемости кода и обеспечения более удобного отладочного опыта. Однако это не является обязательным требованием для всех классов.

Если вы хотите, чтобы ваш пользовательский класс имел подробное строковое представление для отладки и просмотра, вы можете определить метод .__repr__(). Это позволяет легче понять и отслеживать содержимое объекта. Если вам нужно простое и информативное строковое представление для использования в основном коде программы, вы можете определить метод .__str__().

Выбор того, какие методы определить, зависит от ваших конкретных потребностей и ожиданий от класса.

Вывод

Использование .__repr__() и .__str__() позволяет контролировать строковое представление объектов в вашем коде Python. Определение этих методов в пользовательском классе может значительно улучшить читаемость и отладку вашего кода. Когда вы используете .__repr__() для программистов и .__str__() для пользователей, вы можете обеспечить доступную и информативную информацию о ваших объектах в разных контекстах.

Написание хорошо организованного, понятного и документированного кода является ключевым аспектом профессиональной разработки на Python. Используйте .__repr__() и .__str__() ваших пользовательских классов, чтобы сделать ваш код более ясным и удобочитаемым как для вас, так и для других разработчиков, которые будут работать с вашими классами.