Context manager в рамках языка Python

Python - это язык программирования, уделяющий много внимания тому, как мы пишем код. Самый первый пункт Zen of Python, принципов разработки на Python от его BDFL: “Beautiful is better than ugly”. Красивое лучше уродливого. Это само по себе простое и понятное утверждение, вынесенное на первое место в дзэне, напоминает нам простую истину - мы пишем код для людей, а не для машин. Машине для исполнения программы хватит нулей и единиц в бинарном файле, человек же куда более требователен.

Именно поэтому в разработке кода мы стараемся использовать все доступные средства, для того чтобы сделать его удобным для чтения и понятным человеку. В Python множество инструментов, которые могут помочь улучшить читаемость кода, и Context manager, о котором дальше пойдет речь, один из них.

Прежде чем перейти к менеджеру контекста, вспомним что такое сам контекст.

Блоки повторяющегося кода для работы с файлами demo_1.txt и demo_2.txt могут быть разбиты на отдельные шаги:

В данном примере контекстом будет вызов метода write.

13 мая 2005 года вышел PEP-343, который определил новое ключевое слово with, а также методы __enter__() и __exit__(), которые выполняются соответственно при входе и выходе из блока with.

Количество дуплицированного кода уменьшилось, читабельность улучшилась, функционал остался прежним.

Менеджером контекста называется объект, реализующий вышеобозначенные методы __enter__() и __exit__().

В примере выше функция open может выглядеть как менеджер контекста, однако это не совсем так — им является результат ее выполнения, а именно файловый дескриптор.

Рассмотрим пример использования менеджера контекста для отсчета времени выполнения некоторого блока кода. Пример взят из реального проекта, хоть и несколько упрощен для наглядности.

Создадим менеджер контекста timer

Стоит отметить, что метод __exit__() всегда принимает 4 аргумента в следующем порядке:

Эти данные можно использовать для более тонкой обработки исключений или для отладки. Имена аргументов остаются на усмотрение разработчика.

В PEP 343 также был представлен и более элегантный и эффективный способ создания менеджера контекста, а именно использование декортора contextmanager.

Генератор созданный с помощью декоратора contextmanager возвращает объект с автоматически созданными необходимыми методами __enter__() и __exit__(). В таком случае метод __enter__() возвращает next(), выполняя код до ключевого слова yield. __exit__() же, пытаясь получить второй next(), выполняет код после.

Именно последний вариант стал общепринятым стандартом разработки.

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

Следующие примеры взяты из нескольких наиболее популярных open-source проектов на Python. Каждый пример содержит определение менеджера контекста и его использование.

https://github.com/scrapy/scrapy

В репозитории scrapy, созданном для сканирования и парсинга веб страниц, можно найти следующий пример использования менеджера контекста. Здесь он использован с целью выставления временных переменных среды, возвратом к предыдущему состоянию после выхода из контеста, выполнения блока кода под оператором with.

https://github.com/Textualize/rich

Менеджер контекста может быть использован и просто для улучшения читаемости кода. Предлагаю обратить внимание на имплементацию демо функционала в известном репозитории rich, созданном для того, чтобы предоставить функционал для работы с текстом. Каждое действие здесь, в коде демо презентации, сопровождается небольшой паузой по окончанию выполнения для улучшения восприятия зрителем. Вместо того, чтобы вызывать time.sleep каждый раз, разработчик нашел элегантное решение с менеджером контекста beat.

https://github.com/certbot/certbot

Данный пример взят из репозитория cert, созданным облегчить работу с сертификатами для https соединения. В нем разработчик использует менеджер контекста для того, чтобы гарантировать возврат к старой маске разрешений пользователя после того, как выполнится блок кода.

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

Оригинал статьи: