Gerenciador de Contexto Python

Embora os gerenciadores de contexto do Python sejam amplamente utilizados, poucos entendem o propósito por trás de seu uso. Essas instruções, comumente usadas na leitura e escrita de arquivos, ajudam a aplicação a conservar a memória do sistema e melhoram o gerenciamento de recursos, garantindo que recursos específicos sejam usados apenas para determinados processos.

A instrução with

Um gerenciador de contexto é um objeto que é notificado quando um contexto (um bloco de código) começa e termina. Você comumente usa um com a instrução with. Ele cuida da notificação.

Por exemplo, objetos de arquivo são gerenciadores de contexto. Quando um contexto termina, o objeto de arquivo é fechado automaticamente:

# Gerenciador de contexto: lida automaticamente com a limpeza de recursos
# O arquivo é fechado automaticamente ao sair do bloco 'with'
with open(filename) as f:  # 'f' é o objeto de arquivo
    file_contents = f.read()

# O arquivo é fechado automaticamente aqui, mesmo que um erro tenha ocorrido

Qualquer coisa que termine a execução do bloco faz com que o método de saída do gerenciador de contexto seja chamado. Isso inclui exceções e pode ser útil quando um erro faz com que você saia prematuramente de um arquivo ou conexão aberta. Sair de um script sem fechar adequadamente arquivos/conexões é uma má ideia, o que pode causar perda de dados ou outros problemas. Ao usar um gerenciador de contexto, você pode garantir que precauções sejam sempre tomadas para evitar danos ou perdas dessa forma.

Escrevendo seu próprio gerenciador de contexto

Também é possível escrever um gerenciador de contexto usando sintaxe de gerador graças ao decorador contextlib.contextmanager:

# Gerenciador de contexto baseado em função usando o decorador contextlib
import contextlib
@contextlib.contextmanager
def context_manager(num):
    print('Enter')  # Código antes do yield é executado em __enter__
    yield num + 1   # Valor cedido se torna a variável 'cm'
    print('Exit')    # Código após o yield é executado em __exit__

with context_manager(2) as cm:  # cm recebe o valor cedido (3)
    print('Right in the middle with cm = {}'.format(cm))

Enter
Right in the middle with cm = 3
Exit

Gerenciador de contexto baseado em classe

Você pode definir um gerenciador de contexto baseado em classe. Os métodos chave são __enter__ e __exit__

# Gerenciador de contexto baseado em classe: implementa os métodos __enter__ e __exit__
class ContextManager:
    def __enter__(self, *args, **kwargs):  # Chamado ao entrar no bloco 'with'
        print("--enter--")
        return self  # Pode retornar um objeto para usar como variável 'as'

    def __exit__(self, *args):  # Chamado ao sair do bloco 'with'
        print("--exit--")

with ContextManager():  # Chama __enter__, depois __exit__ quando concluído
    print("test")

--enter--
test
--exit--

Links relevantes

• Leitura e Escrita de Arquivos
• Tratamento de Exceções
• Decorators
• 10 Operações Essenciais do Sistema de Arquivos que Todo Desenvolvedor Deve Conhecer
• open()