[Python] 주석 작성 및 타입 힌트 알아보기

파이썬의 주석 작성 알아보기

---

프로그래밍을 할 때 가장 중요한 기술로 주석(annotation)을 빼놓을 수 없습니다. 주석은 프로그램 실행에는 전혀 영향을 주지 않지만, 코드를 읽거나 쓰는 사람들이 프로그램의 구조를 효과적으로 이해할 수 있도록 작성하는 메모입니다. 코드를 100% 이해할 수 있다면야 이론적으로 필요 없는게 주석이지만, 실제로는 베테랑 개발자들도 주석 없이는 이해할 수 없는 코드가 잔뜩 있기 때문에, 주석을 써놓는건 기본 중의 기본으로 교육되고 있지요.

 

이번에는 파이썬(Python)에서 사용되는 다양한 주석의 표현 방법에 대해서 알아보도록 하겠습니다.

 

 

# 기호를 사용한 주석

---

파이썬에서는 주석을 작성할 때 기본적으로 # 표기를 사용합니다. # 기호는 해당 기호 오른쪽에 있는 글자를 모두 주석 처리한다는 의미를 가지고 있지요. 글자 하나로 작성하기 때문에 편리하지만, 딱 한 줄만 주석 처리를 할 수 있다는 단점이 있습니다. 이 주석을 사용한 코드는 아래와 같이 작서됩니다.

 

 

# 여기에 함수 설명을 입력할 수 있습니다
def hello():
    return 'hello'

print(hello())  # 코드 옆에 주석을 쓸 수도 있습니다

hello

 

 

문자열을 이용한 주석

---

파이썬 코드 사이에 문자열을 끼워넣으면, 해당 문자열은 프로그램 실행에 영향을 주지 않습니다. 개발자들 사이에서는 이런 특징을 활용해서 문자열을 주석으로 써먹는 경우가 종종 있습니다. 파이썬에서는 따옴표 세 개로 묶은 문자열, 가령 '''안녕하세요''' 와 같은 표현은 줄바꿈을 허용하기 때문에, 여러 줄의 주석을 입력할 때 요긴하게 사용되는 방식입니다.

 

다만, 이 방법은 반환값을 화면에 출력해 주는 주피터 노트북(Jupyter Notebook) 등의 개발환경(IDE)에서는 보기 지저분할 수 있다는 단점이 있고, 코드 옆에는 적을 수 없다는 단점 또한 있습니다.

 

 

def hello():
    '''
    함수 설명을 여러 줄 적어야 할 때
    문자열을 이용한 주석을 활용하는 분들이 있습니다
    '''
    return 'hello'

print(hello())
'여기에 문자열로 주석을 적으면, 주피터 노트북 등에서는 반환값으로 화면에 출력됩니다'

hello

[Output] '여기에 문자열로 주석을 적으면, 주피터 노트북 등에서는 반환값으로 화면에 출력됩니다'

 

print('nice to meet you!')  '여기에 문자열을 적으면 에러가 납니다'

  Cell In[3], line 1
    print('nice to meet you!')  '여기에 문자열을 적으면 에러가 납니다'
                                ^
SyntaxError: invalid syntax

 

 

자료형을 명시하는 주석 (타입 힌트)

---

파이썬은 코드를 실행하는 시점에 각 요소의 자료형이 결정되는 동적 타입 언어입니다. 그래서 동적 타입 언어의 특성상 변수를 정의할 때 자료형을 명시하지 않고 자유롭게 입력이 가능하지요. 그래서, 자료형을 잘못 입력해서 발생하는 에러가 빈번한 편입니다. 이런 문제를 예방하기 위해서는, 변수를 정의할 때 어떤 자료형을 입력할지 미리 알려주는 것이 중요합니다. 이걸 타입 힌트(Type Hint)라고 하지요. 타입 힌트는 변수 이름: 자료형 과 같이 작성합니다.

 

타입 힌트는 변수에 입력할 자료형을 눈에 보이도록 명시해 둔다는 점이 장점이지만, 강제성이 없다는 점이 단점입니다. 개발 환경에 따라서는 타입 힌트와 다른 자료형을 입력할 경우 경고 메시지를 출력하는 기능이 있지만, 그마저도 개발자가 무시할 수 있기 때문에, 타입 힌트는 개발자 사이의 약속이라고 이해하면서 잘 지켜 주시는게 좋습니다.

 

 

a: str = 'adf'  # a 변수는 문자열만 입력하겠다고 선언합니다
b: int  # 변수를 정의하지 않은 상태에서 미리 적어만 둘 수도 있습니다

a = 123  # 문자열을 입력하겠다고 선언한 a에 정수를 입력해도 에러는 안생깁니다

 

 

함수의 반환값을 명시하는 주석

---

파이썬의 함수가 길어지면 주석의 반환값을 알아보기 어려운 경우가 종종 생깁니다. 문서화를 잘 해 두었다면 각 함수마다 입출력 형태에 대한 이해가 빠르겠지만, 모든 프로그램에 상세한 문서를 작성하기는 어렵죠. 코드 상에 표시를 한번 더 해 두고 싶은 경우나 문서를 따로 만들기에는 너무 간단한 코드라면 주석으로 이를 표시할 수 있습니다. 파이썬에서는 함수의 반환값에 대해서 특별한 형태의 주석을 허용하는데요, 바로 함수 이름(매개변수) -> 자료형: 형태입니다.

 

 

def hello() -> str:  # 문자열로 반환을 해 주는 hello() 함수
    return 'hello'

print(hello())

hello