Как спроектировать собственный класс Python

← Все подборки материалов

Разработка · 4 материала

Собственный класс Python полезно проектировать как договор о поведении: какое состояние допустимо после инициализации, как его разрешено менять, что увидит пользователь и какими примерами это проверить. Тогда __init__, property, __str__/__repr__ и тесты оказываются частями одной модели, а не набором специальных методов ради упражнения.

4 материала по задачеПерейти к инструкциям ↓
В этой подборке

Материалы подборки

Выберите инструкцию под свою задачу. Ниже — подробный разбор выбора и проверки результата.

Начните с правила состояния

Рассмотрим собственный учебный пример: счётчик мест в небольшой аудитории. У него есть вместимость и количество занятых мест. Предлагаемое правило: вместимость положительна, занятое количество неотрицательно и не превышает вместимость. Это условие должно сохраняться после каждой разрешённой операции. Реального запуска этого примера здесь не предполагается: сначала мы формулируем проект и проверки.

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

Часть класса Решение для учебного счётчика Наблюдаемая проверка
Инициализация Допустимая вместимость и начальная занятость Новый экземпляр сразу удовлетворяет правилу состояния
Изменение Нельзя занять больше свободного или освободить больше занятого Недопустимый запрос не оставляет объект в частично изменённом состоянии
Чтение Свободные места вычисляются из согласованных значений Повторное чтение не меняет количество мест
Представление Понятное описание для человека и полезная диагностика для разработчика Строка отражает текущее состояние без лишних данных

Согласуйте начало и последующие изменения

Метод __init__ инициализирует экземпляр; не следует приписывать ему самостоятельное выделение или создание объекта. На этом шаге важно избежать ситуации, когда неверные исходные данные приняты, хотя позднее аналогичное изменение запрещается. Если правило одно, разные входы в класс должны соблюдать его согласованно.

Для простого значения может подойти обычный атрибут. Если чтение или присваивание требует вычисления и проверки, рассмотрите property. Оно позволяет сохранить привычный публичный доступ к свойству и поместить за ним логику. Однако property не делает данные недоступными и не служит средством защиты секретов. Поддерживаемый интерфейс и границы доверия — разные вопросы.

В нашем примере свободные места можно вычислять при чтении. Занятие и освобождение удобнее описывать действиями, если у них несколько проверок и свой смысл отказа. Не маскируйте неожиданно сложную операцию под безобидное получение свойства. Читатель класса должен понимать, какая команда меняет состояние.

Опишите объект для двух читателей

__str__ помогает дать понятный человеку текст, например состояние аудитории. __repr__ предназначен для более точного диагностического представления. Не требуется, чтобы repr любого объекта можно было выполнить и воссоздать экземпляр. Важнее однозначно показать полезные для разбора сведения.

У обоих представлений проверьте актуальность после изменения. Не включайте в них ключи доступа и персональные данные: диагностическая строка может попасть в журнал. Для учебного счётчика достаточно количеств, без имён посетителей. Получение строки само по себе не должно неожиданно занимать или освобождать место.

Проверьте поведение, а не устройство

Составьте случаи: допустимое создание, ошибочное создание, занятие последнего места, отказ при переполнении, освобождение и повторное чтение. Отдельно создайте два экземпляра и убедитесь, что изменение одного не меняет другой. После отклонённой операции сравните состояние с тем, что было до вызова.

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