with 문과 컨텍스트 관리자(Context managers)

context managers와 with statement

Python의 with 문은 깨끗하고 읽기 쉬운 Python 코드를 작성하는 데 도움이 될 수 있는 구문입니다. 특성(변수)을 추상화하고 팩토링하여 재사용할 수 있도록 하여 일부 일반적인 리소스(resource) 관리 패턴을 단순화하는 데 도움이 됩니다. 이 구문으로 기본 구조는 식 1과 같습니다.

with 객체 as 별칭: 내 용

(식 1)

위 with 문은 객체에 대한 하위코드(들)를 내용으로 포함하는 블럭을 형성하며 하위코드에서 객체의 이름을 대신할 별칭(alias)을 키워드 as를 사용하여 정의할 수 있습니다. 이것은 그 객체의 동작과 변화들을 그룹화하기 때문에 객체의 관리를 단순화 하는 데 유리하며 코드의 가독성의 개선에 도움이 됩니다.

다음 코드는 파이썬 인터프리터에서 파일을 호출하고 작성하는 메소드들을 사용합니다(파일 운용(File Operation) 참조).

다음 코드는 텍스트 파일을 호출하고 내용을 작성하기 위해 with 문과 파일을 여는 내장함수인 open(파일, 'w')을 사용한 것입니다.

with open('test.txt', 'w') as f:
    f.write('Hello, World!')

with문을 사용하지 않을 경우 동일한 결과를 위한 코드는 다음과 같습니다.

f=open('test.txt','w')
f.write('Hellow, World!')
f.close()

위 코드는 f.write() 함수에 예외가 발생할 경우 f.close()함수는 실행되지 않습니다. 즉 파일이 열린 상태에서 더 이상의 명령은 작동되지 않습니다. 이를 예방하기 위해 try문을 적용할 수 있습니다.

f=open('test.txt', 'w')
try:
    f.write('Hellow, World!')
finally:
    f.close()

with 문은 try~finally 문을 포함한 위 코드와 같습니다. 즉 with 구문은 컨텍스트 관리자(context manager)를 구현하여 고유한 클래스 및 함수에서 동일한 기능을 제공할 수 있습니다.

컨텍스트 관리자는 with 문을 지원하기 위해 객체가 따라야 하는 간단한 프로토콜 또는 인터페이스입니다. 기본적으로 객체가 컨텍스트 관리자로 작동하도록 하려면 객체에 __enter__ 및 __exit__ 메서드를 추가하기만 하면 됩니다. Python은 리소스 관리 주기의 적절한 시간에 이 두 메서드를 호출합니다. 예로 문서를 호출하고 작업하고 닫는 과정에 대한 컨텍스트 관리자의 간단한 구현은 다음과 같습니다.

class ManagedFile:
    def __init__(self, name):
        self.name=name
    def __enter__(self):
        self.file=open(self.name, 'w')
        return self.file
    def __exit__(self, exc_type, exc_val, exc_tb):
        if self.file:
            self.file.close()

ManagedFile 클래스는 컨텍스트 관리자의 프로토콜에 맞게 __enter__, __exit__ 메소드를 포함합니다. 그러므로 원래의 open() 예제와 마찬가지로 with 문을 지원합니다.

with ManagedFile('test.txt') as f:
    f.write('hellow, world')
    f.write('bye now')

이 클래스를 호출하면 with 문의 컨텍스트에 들어갈 때 __enter__를 호출하고 with 문내의 코드를 실행합니다. 이 실행(들)을 마치면, 즉 컨텍스트를 벗어나면 __exit__를 호출하여 with 문을 종료합니다.

표준 라이브러리의 contextlib 유틸리티 모듈은 기본 컨텍스트 관리자 프로토콜 위에 구축된 몇 가지 추상화를 더 제공합니다. 예를 들어, contextlib.contextmanager 데코레이터를 사용하면 with 문을 자동으로 지원하는 리소스에 대한 생성기 기반 팩토리 함수를 정의할 수 있습니다. 이 기술을 사용하여 ManagedFile 컨텍스트 관리자 예제를 다시 작성하면 다음과 같습니다.

from contextlib import contextmanager

@contextmanager #데코레이터(장식자)
def managed_file(name):
    try:
        f=open(name, "w")
        yield f
    finally: 
        f.close()

with managed_file('test.txt') as f:
    f.write('hellow, word!')
    f.write("bye now")

위 with문의 경우 managed_file()은 먼저 리소스(resource)를 획득하는 생성기입니다. 그 생성 후 생성기(managed_file())는 일시적으로 자체 실행을 일시 중단하고 with 문 블럭내에 포함된 명령들이 실행됩니다. 그 후 with 컨텍스트를 떠나면 그 생성기가 다시 실행되어 나머지 정리 단계가 발생할 수 있고 리소스가 시스템으로 다시 해제될 수 있습니다.

클래스 기반 구현과 생성기 기반 구현은 본질적으로 동일합니다. 더 읽기 쉬운 접근 방식에 따라 둘 중 하나를 선호할 수 있습니다. @contextmanager 기반 구현의 단점은 데코레이터 및 생성기와 같은 고급 Python 개념에 대한 이해가 필요하다는 것입니다.

컨텍스트 관리자는 매우 유연하며 with 문을 창의적으로 사용하면 모듈 및 클래스에 대한 편리한 API를 정의할 수 있습니다. 예를 들어, 들여쓰기를 할 수 있는 context manager를 생성할 수 있습니다.

class Indenter:
    def __init__(self):
        self.level=0
    def __enter__(self):
        self.level +=1
        return self
    def __exit__(self, exc_type, exc_val, exc_tb):
        self.level -=1
    def print(self, text):
        print('  '*self.level+text)

with Indenter() as idt:
    idt.print("시작합니다.")
    with idt:
        idt.print('첫번째 들여쓰기')
        with idt:
            idt.print("두번째 들여쓰기")
    idt.print("처음으로") 

시작합니다.
    첫번째 들여쓰기
      두번째 들여쓰기
  처음으로