Python underscore 관련 naming convention

2018-05-26

파이썬에는 PEP-8이라는 Python Code Style Guide가 있다. 모든 내용을 한 번에 정리하기 어려워서 그냥 코딩하다가 궁금한 것 위주로 정리해 보려고 한다.

이번 글에서는 ‘_’(Underscore)가 붙는 변수나 메서드에 관련한 내용을 정리하려고 한다.

_single_leading_underscore: 이런 경우 from M import *에서는 _로 시작하는 object를 import 하지 않는다.
single_trailing_underscore_: 파이썬 언어 내에서 사용되는 키워드와의 충돌을 피하기 위해 작성한다. BeautifulSoup에서 HTML의 class를 기준으로 무언가를 찾을 때 class_와 같이 속성을 지정해 줄 때가 있다.
__double_leading_underscore: 클래스 속성의 이름을 정할 때 name mangling을 피한다. 아래에 그 예가 있으니 참고하면 될 것 같다.
__double_leading_and_trailing_underscore__: 사용자가 컨트롤하는 네임스페이스에 있는 “magic” object나 속성이다. 예를 들어 __init__, __import__, __file__등이 있다. 이러한 이름을 새로 만들 일은 거의 없을 것 같다.

파이썬 모듈에서 C나 C++로 작성한 확장 모듈을 이용할 때, C나 C++ 모듈은 앞에 _를 하나 붙여준다. PEP-8 문서에서는 _socket을 예로 들고 있다.

from M import *을 사용하여 모듈을 import 하는 경우, __all__ 변수를 사용해서 특정한 global 변수를 외부에서 쓰지 못 하도록 막을 수 있다.

# M.py
__all__ = [aaa, bbb]

aaa = 1
def bbb():
    return 'bbb'

def ccc():
    return 'ccc'

아래와 같이 M 모듈을 import 하고 ccc를 실행하면 예외가 발생한다.

from M import *

print(aaa)
print(bbb)

# 여기서 예외가 발생한다.
print(ccc)

참고: Foo 클래스가 __a라는 속성이 있으면, Foo.__a로 접근할 수 없다. 사용자는 Foo._Foo__a로만 접근할 수 있다. 상/하위 클래스 간 이름이 충돌하지 않도록 구현하는 경우에만 사용해야 한다.

Java나 C++과 같은 언어에서는 public, private와 같이 속성이나 메소드의 접근 가능 범위를 지정해 주는 키워드가 존재한다. 하지만 파이썬에는 그런 키워드가 없다. 대신에 다음과 같은 코딩 스타일을 이용한다.

Python에서 _를 쓰는 다른 용법이 있는데, 개인적으로 몰랐던 부분이 있어서 아래 링크한 글이 많은 도움이 되었다.