Python

With

with EXPRESSION [as VARIABLE]:
	BLOCK

• 보통 프로그램은 파일에 접근해서 파일 내용 등을 읽고 쓰고 삭제하고 수정하는 등등 무언가의 일을 수행한 뒤 그 파일을 해제(close) 하는 패턴을 따름
  • 예를 들어 우리가 엑셀 파일을 열었는데 그 엑셀 파일을 열고 있는 동안에는 다른 프로그램에서 엑셀 파일에 접근할 수 없게 됨
  • 거두절미하고 파일을 열었으면 닫아주는 일을 빼먹지 말아야 한다는 것
• 보통은 close() 등과 같은 메소드를 사용하지만 여기에는 숨은 문제점이 있음
  • 파일 처리를 수행하는 도중에 오류가 발생하게 되면 close() 문을 실행할 수 없고 그렇게 되면 이 파일은 영원히 닫을 수가 없게 됨
  • with문은 그 구문을 실행했을 때 오류가 발생하든 안하든 마지막에 close 를 해주도록 하는 것

• 파이썬을 활용하다보면 파일을 열고 수정한 후, 닫는 형태의 프로세스가 많음
  • 보통은 객체의 .Quit()라던가 .Close()와 같은 함수를 통해 직접 파일을 닫음
  • 만약, 객체를 닫는 함수를 사용하지 않으면 프로그램이 종료되어도 계속 해당 객체가 열려있어 메모리를 점유하고 있게 되므로 메모리를 불필요하게 낭비하게 되는 것
• 그래서 파이썬에서는 with ~ as ~ 라는 구문을 제공
  • 개발자가 실수로 close() 를 하지 않아도 with ~ as ~ 구문이 끝나면 자동으로 객체를 close 하게 해줌

Tip! 추가 내용

• 자원을 획득하고 사용 후 반납해야 하는 경우 주로 사용
  • 자원을 획득
  • 자원을 사용
  • 자원을 반납

• 예를 들어 파일을 열고 사용했다면 다른 프로세스를 위해 닫고 반납해야 함
  • 데이터베이스 세션을 얻어 사용했다면 다른 프로세스를 위해 반납해야 함
  • 자원은 한정되어 있기 때문에 적절히 획득과 반납해야 함

동작 방식

• 파이썬은 특수메소드를 사용
  • 클래스를 알고 있다면 이해하기 쉬울 것이고 모르면 이 부분은 넘어가도 상관없음
  • __enter__ 와 __exit__ 특수메소드를 가진 객체에 with 문을 쓸 수 있는 것
  • with 문 내 표현식은 한 객체로 평가됨
    • 이어서 이 객체의 __enter__ 메서드가 호출되고 끝으로 호출 결과가 변수에 할당되는 것
    • 블록을 모두 실행하면 블록에서 오류가 발생했더라도 파이썬은 그 객체에 __exit__메서드를 호출하게 됨
    • 파일 객체의 __exit__ 메소드는 파일을 닫음

# 예시 코드
class Hello:
    def __enter__(self):
        # 사용할 자원을 가져오거나 생성
        print('enter...')
        return self # 반환값이 있어야 VARIABLE을 블록 내에서 사용할 수 있음
        
    def sayHello(self, name):
        # 자원을 사용
        print('hello ' + name)

    def __exit__(self, exc_type, exc_val, exc_tb):
        # 마지막 처리 (자원 반납 등)
        print('exit...')

with Hello() as h:
    h.sayHello('hwaya')
    h.sayHello('hwaya2828')


# 결과
enter...
hello hwaya
hello hwaya2828
exit...

• 클래스의 객체를 바로 만들고 만든 객체를 이용하여 인사를 하고 만든 객체를 소멸시킴

• 객체의 라이프사이클(생성 >> 사용 >> 소멸)을 설계할 수 있음
  • 필요 이상으로 오래 들고 있거나 여기저기 넘기면서 불필요한 객체에게 넘겨서는 안됨
  • 각 객체들은 단일 책임을 지고 설계된 라이프사이클에 따라 움직여야 좋음

Tip! 추가 예시

with open('textfile.txt', 'r') as file:
    contents = file.read()

# 위 구문과 동일한 내용
file = open('textfile.txt', 'r')
contents = file.read()
file.close()

• 두번째 코드를 실행한다고 할 때 만약에 content = file.read() 에서 에러가 난다면 file을 닫을 수 없음
  • 그러나 with 문을 사용하면 에러가 나더라도 file을 자동으로 닫아줌

Tip! 추가 예시

# 예시 코드
class Withtest: 
    # 초기화 메서드 정의 
    def __init__(self): 
        self.temp = "초기화 메서드" 
   
    # 객체가 호출될 때 자동으로 실행 
    def __enter__(self): 
        print(self.temp) 
        return self # 반환값이 있어야 VARIABLE을 블록내에서 사용할 수 있음
   
    def printText(self): 
        print("메소드 호출 테스트") 
   
    # with 구문 통해 객체가 종료될 때 자동으로 실행 
    def __exit__(self, exc_type, exc_val, exc_tb): 
        # 종료 구문 설정 (세션의 종료 등) 
        print('with 통해 종료') 
   
    # 객체 생성 및 with 구문 실행 
    if __name__ == "__main__": 
        withclass = Withtest() 
   
    with withclass as wc: 
        wc.printText()


# 결과
초기화 메서드
메소드 호출 테스트
with 통해 종료

• 위 코드를 확인해보면 실행부에서 withclass라는 클래스 객체를 생성했고 아래 with 문을 통해 printText( ) 메소드를 호출
  • with 구문을 통해 실행하니 __enter__( ) 메소드와 __exit__( ) 메소드가 실행된 것을 확인할 수 있음
  • 참고로 __exit__( ) 메소드의 매개변수인 exc_type, exc_val, exc_tb는 with 문을 빠져나오기 이전에 예외가 발생했을 때를 나타내는 정보
• 위와 같은 코딩 방식은 Python Context Managers 방식 중의 하나