Python - assert 사용 방법

assert는 디버깅 목적으로 사용되는 구문입니다.

예를 들어, 함수에서 어떤 인자는 항상 0보다 큰 값을 전달하도록 설계하였는데, 누군가가 실수로 0 이하의 값을 전달할 때 Exception을 발생시켜 프로그램을 종료시키고 디버깅하고 싶을 수 있습니다. 이럴 때 assert로 인자의 조건을 체크하고 AssertionError을 발생시킬 수 있습니다.

1. assert의 기본 사용 방법

assert의 오른쪽 조건이 True일 때 AssertionError가 발생하지 않으며, 프로그램은 멈추지 않고 계속 동작합니다.

n = 10

assert n > 0

하지만, 아래와 같은 코드에서 assert의 오른쪽 조건은 False가 되며, 이 때 AssertionError가 발생합니다.

n = 0

assert n > 0

Output:

Traceback (most recent call last):
  File "/home/js/IdeaProjects/python-ex/ex.py", line 3, in <module>
    assert n > 0
AssertionError

1.1 구체적인 에러 메시지 출력

assert로 에러가 발생했을 때, 왜 문제가 되었는지 한눈에 파악하기 힘들 수 있습니다.

아래와 같이 assert의 오른쪽에 메시지를 입력하면, 에러가 발생할 때 함께 출력하여 디버깅하는데 도움이 될 수 있습니다.

n = 0

assert n > 0, f"n must be positive, but n is {n}"

Output:

Traceback (most recent call last):
  File "/home/js/IdeaProjects/python-ex/ex.py", line 3, in <module>
    assert n > 0, f"n must be positive, but n is {n}"
AssertionError: n must be positive, but n is 0

2. 함수에서 assert 사용

함수에서도 동일하게 assert를 사용하여 변수나, 인자를 검사할 수 있습니다.

def my_function(n, names):
    assert n > 0, f"n must be positive, but n is {n}"
    assert len(names) > 0, "names must not be empty"


my_list = []
my_function(10, my_list)

3. assert 비활성화

디버깅에만 assert를 사용하고, 실제로 프로그램을 사용할 때는 assert를 비활성화하고 싶을 수가 있습니다. 강제로 Error를 발생시켜 프로그램을 종료시키는 것보다, 잘못 동작하더라도 프로그램이 종료되지 않는 것이 중요할 수 있기 때문입니다.

아래와 같이 파이썬 스크립트를 실행할 때 -O 옵션을 추가하면 assert가 비활성화되며, assert가 어떤 에러도 발생시키지 않습니다.

$ python -O script.py