[python] 밑줄과 내장메소드(Underscores & Built-in method)

밑줄과 내장 메소드(Underscores & Built-in method)

1. 밑줄의 유형

단일 및 이중 밑줄("_, __")은 일부는 단지 관례적으로 사용되지만 클래스를 초기화시키기 위해 적용되는 내장 메서드인 생성자 __init__()와 같이 일부는 파이썬 변수 및 메서드에 첨가하여 특정한 의미를 부여합니다. 대략적으로 다음과 같이 분류할 수 있습니다.

• 단일 선행 밑줄: _var
  • 변수 또는 메서드가 내부 사용을 위한 것임을 나타내는 규칙
  • 단일 선행밑줄의 객체를 와일드카드(*)로 호출할 경우를 제외하고 실행상 차이는 없음
• 단일 후행 밑줄: var_
  • 후행 밑줄(접미사)은 규칙에 따라 파이썬 키워드와의 이름 충돌을 피하기 위해 사용됩니다.
• 이중 선행 밑줄: __var
  • 작동영역을 한정시킴
• 이중 선행 및 후행 밑줄: __var__
  • 파이썬 클래스에 공통적으로 사용되는 내장 메소드(매직 메소드)를 나타내기 위한 명명 규칙
• 단일 밑줄:_
  • 임시 또는 중요하지 않은 변수를 나타낼 경우 사용되는 명명규칙

2. 단일 선행 밑줄(Single leading underscore)

변수 및 메서드 이름과 관련하여 단일 밑줄 접두사는 관례적으로 사용하는 것으로 프로그램의 동작에는 영향을 미치지 않습니다. 다시 말해 단일 밑줄로 시작하는 변수 또는 메서드는 내부 사용을 위한 것임을 암시하기 위해 사용합니다. 파이썬은 Java와 같이 "개인" 변수와 "공용" 변수를 크게 구분하지 않기 때문에 실행 상 어떤 변화를 나타내지 않습니다.

class test:
        def __init__(self):
            self.foo=11
            self._bar=23

t=test()
t.foo

11

t._bar

23

단일 밑줄 접두사는 단지 합의된 규칙이기 이므로 클래스 test의 속성 _bar의 실행은 정상적으로 이루어집니다. 최소한 변수 및 메서드 이름에 관해서는 그렇습니다. 그러나 선행 밑줄을 가진 이름을 임포트하는 경우 제약이 존재합니다. 다음은 my_test.py 파일에 별도로 저장된 함수들입니다.

def external_func():
    return 23

def _internal_func():
            return 42

위 파일을 import 하기 위해 sys.path.append() 메소드를 사용하여 파이썬의 호출 경로를 등록합니다.

sys.path.append("~/파이썬")
sys.path

['/~/파이썬',
'/~/anaconda3/lib/파이썬38.zip',
 ⋮
 ]

다음과 같이 와일드카드(*)를 사용하여 import 한 경우 파이썬은 선행 밑줄이 있는 이름을 가져오지 않습니다

from 패키지 또는 모듈이름 import *

와일드카드는 대상을 특정하지 않음을 나타냅니다. 그러므로 "import 문"에서 *의 적용은 패키지 또는 모듈의 모든 내용을 호출함을 의미합니다.

from my_test import *
external_func()

23

_internal_func()

NameError: name '_internal_func' is not defined

위와 같이 와일드카드를 이용한 import의 경우를 제외하고 선행 밑줄은 단지 코드를 구분하기 위한 파이썬의 규칙으로 실행에서의 차이는 없습니다.

import my_test
my_test.external_func()

23

my_test._internal_func()

42

3. 이중 선행 밑줄(double leading underscore)

단일 밑줄의 경우 구분을 위한 규칙인데 반해 이중 밑줄는 작용범위를 한정하기 위해 사용합니다. 예를 들어 클래스에 이중 선행 밑줄을 포함하는 함수 또는 속성의 경우 그 클래스를 상속받는 하위클래스에서 그들을 재정의(overloading)하여 사용할 수 없습니다. 다음은 단일과 이중 밑줄 속성을 포함한 클래스입니다.

class Test:
    def __init__(self):
        self.a=11
        self._b=23
        self.__c=24

T=Test()
T.__dict__

{'a': 11, '_b': 23, '_Test__c': 24}

위 결과는 클래스 인스턴스인 T의 모든 속성(attribute)를 나타낸 것입니다. 이 결과에서 선행 이중 밑줄을 가진 속성 __c은 소속된 클래스가 명시되어 있습니다. 이것은 선행 이중 밑줄을 가진 속성은 소속된 클래스외의 부분에서는 재정의를 할 수 없음을 의미합니다.

다음은 클래스 Test를 상속받는 자식 클래스 SubTest입니다.

class SubTest(Test):
    def __init__(self):
        super().__init__()
        self.a=0 #재정의
        self._b=3 #재정의
        self.__c=4 #SubTest의 속성

subT=SubTest()
subT.__dict__

__dict__()는 클래스가 포함하는 속성이나 메서드를 반환하는 내장메서드입니다.

{'a': 0, '_b': 3, '_Test__c': 24, '_SubTest__c': 4}

subT.__c__

AttributeError: 'SubTest' object has no attribute '__c__'

부모와 자식 클래스인 Test와 SubTest는 모두 이중 밑줄의 속성 __c를 포함합니다. 이 이중밑줄의 객체는 재정의되지 않으므로 같은 이름이지만 소속이 다른 두 개의 __c를 포함합니다. 이는 다음과 같이 __dict__의 결과로 확인할 수 있습니다.

subT._Test__c

24

subT._SubTest__c

4

위 결과와 같이 선행 이중 밑줄은 속성을 특정 클래스에 한정하여 지정하기 위해 사용합니다. 이 방법을 사용하여 개인 속성(private attribute) 정의할 수 있습니다. 그러므로 클래스를 상속하는 자식 클래스에서 이중 밑줄 접두사로 되어 있는 속성 등의 객체의 재정의를 금지시킬 수 있으며 이것을 name mangling이라고도 합니다.

4. 이중 선행 및 후행 밑줄(Double leading and trailing underscore), 내장메서드

이중 선행 및 후행 밑줄이 있는 이름은 해당 언어에서 특별히 사용하도록 예약되어 있습니다. 이 규칙은 클래스의 생성자인 메서드 __init__나 객체를 호출 가능하게 만드는 __call__와 같이 내장(매직) 메소드들에서 관찰됩니다 (special method 문서 참조). 그러나 이름과 같은 특별한 기능을 가지고 있지는 않습니다. 단지 변경 사항과의 충돌을 피하기 위해 명명 규칙일 뿐입니다. 그러므로 사용자 정의 프로그램에서 선행 및 후행 밑줄과 함께 사용하는 이름은 사용하지 않는 것이 가장 좋습니다.

__init__가 생성자를 작성하기 위해 사용하는 것처럼 매직 메소드는 다음과 같이 특정한 기능에 대응하는 객체를 생성하기 위해 사용합니다.

• 반복(Iteration)
• 컬렉션(Collections)
• 속성접근(Attribute access)
• 연산자 재정의(Operation overloading)
• 함수와 메소드호출(Function and Method invocation)
• 객체 생성과 삭제(Object creating and destruction)
• 문자열 표현(String representation and formatting)
• Managed contexts

예로 내장 메서드 __len__와 __getitem__은 각각 객체의 길이를 반환하고 인덱스에 의한 요소를 호출하기 위한 것입니다. 다음 객체 x는 리스트로서 각 요소에 인덱스가 부여되며 그 인덱스를 사용하여 요소를 호출할 수 있습니다. 이러한 기능은 리스트 클래스에 이미 두 내장 메서드(특별메소드)가 포함되었기에 가능한 것입니다.

x=[1, 2, 3]
('__len__') and ('__getitem__') in dir(x)

True

x.__len__()

3

x.__getitem__(2)

3

위 코드는 메서드를 적용하여 객체 x의 길이와 요소를 호출한 것입니다. 내장 메소드 __len__는 내장함수 len() 함수에 대응하게 합니다. 또한 내장 메소드 __getitem__은 객체에 인덱스 사용을 가능하게 합니다. 위 객체 x는 이 두 메소드를 소유하므로 다음 코드가 작동합니다.

len(x), x[2]

(3, 3)

내장 메소드는 사용자가 아닌 파이썬 인터프리터에 의해 호출됩니다. __len__을 포함한 클래스의 인스턴스가 생성되면 파이썬은 이 메서드를 호출합니다. 또한 호출된 메서드에 대응되는 내장함수를 참조합니다. 즉, 내장함수의 결과는 대응하는 내장 메소드의 결과를 참조합니다. 순서적으로 나타내면 다음과 같습니다.

1. len(객체) 실행
2. 객체가 내장함수 __len__()의 포함 여부를 결정
   1. 포함: len() 실행
   2. 미포함: 에러 발생

사용자 입장에서 객체.__len__() 보다는 len(객체)와 같은 내장함수를 적용하는 것이 일반적입니다.

내장함수는 C파이썬으로 구현된 것으로 파이썬이 메서드를 호출하는 것보다 훨씬 빠릅니다. 대부분의 경우 매직 메소드는 내장함수로 대체할 수 있으므로 사용자가 매직 메소드를 사용하는 경우는 많지 않습니다. 클래스의 생성자인 __init__()가 가장 많이 사용하는 내장 메소드 중의 하나입니다.

내장 메소드인 __repr__, __abs__, __add__, __mul__을 사용하여 클래스를 작성합니다. 이들은 각각 각각 문자열, 절대값, 합, 곱을 선언하는 메서드들이지만 작성된 클래스 Vector에서는 다음과 같이 적용되었습니다.

• __repr__은 객체를 문자화하여 반환하는 것으로 클래스의 객체를 나타냅니다.
• __add__, __mul__은 합과 곱에 대한 메서드로서 각각 '+', '*' 연산자에 대응합니다
• __abs__는 다음과 같이 절대값을 반환하는 메서드이지만 클래스 Vector에서 각 값의 norm(제곱의 합에 대한 제곱근)을 계산하는 함수로 재정의(overriding) 되었습니다. 그러므로 Vector 클래스의 인스턴스인 v에서 호출된 abs()함수는 __abs__() 메서드에 대응하므로 객체의 norm을 계산합니다.

클래스 Vector에 의한 인스턴스들은 repr(), abs(), add(), 그리고 mul() 함수들을 사용하여 연산할 수 있습니다.

class Vector:
    def __init__(self, x, y):
        self.x=x
        self.y=y
    def __repr__(self):
        return f'Vector({self.x}, {self.y})'
    def __abs__(self):
        return (self.x**2+self.y**2)**0.5
    def __add__(self, other):
        X=self.x+other.x
        Y=self.y+other.y
        return Vector(X,Y)
    def __mul__(self, scalar):
        return Vector(scalar*self.x, scalar*self.y)

v1=Vector(2, 4)
v2=Vector(2,1)
v1, v2

(Vector(2, 4), Vector(2, 1))

repr(v1)

'Vector(2, 4)'

repr(v2)

'Vector(2, 1)'

v1+v2

Vector(4, 5)

v=Vector(3, 4)
abs(v)

5.0

v*3

Vector(9, 12)

5. 단일 밑줄(single underscore)

명명규칙에 따라 단일 독립형 밑줄은 변수가 임시적이거나 중요하지 않음을 나타내는 이름으로 사용되는 경우가 있습니다. 예를 들어 다음 반복문에서 인식자는 필요치 않고 단지 반복 횟수만을 나타내므로 단일 밑줄 "_"로 사용했습니다. 즉, 명시적 표현이 필요하지 않음을 나타냅니다.

for _ in range(3):
    print('답')

답
답
답

단일 밑줄 "_"는 특별한 동작을 유발하지 않지만 유효한 변수의 자리임을 나타내기 위해 사용하기도 합니다. 다음 코드에서 "_"는 튜플 객체로 부터 각각의 성분을 호출하기 위한 자리의 표시로 사용되었습니다. 개체 num은 4개의 요소를 가집니다. 이 객체의 첫 번째와 두 번째 요소를 호출하기 위해서는 인덱스를 사용할 수 있습니다. 인덱스 대신에 단일 밑줄을 사용하여 원하는 대상만을 호출할 수 있다.

num=(1, 2, 3, 4)
num[0], num[1]

(1, 2)

4개의 성분을 가진 객체에서 두 개 요소만을 호출하면 에러를 발생합니다.

first, second=num

ValueError: too many values to unpack (expected 2)

대신에 실행은 호출할 요소외에 나머지를 위한 자리를 단일밑줄로 할당하여 에러를 방지할 수 있습니다.

first, second, _, _=num
first, second

(1, 2)

즉, '_'로 각 요소의 위치를 표시하는 것으로 다음과 같이 적용할 수 있습니다. 그러나 '_'는 코드 실행이 아니라 구분을 위해 사용하므로 단일 밑줄의 평가는 예측되지 않은 결과를 일으킬 수 있습니다.

first, _, _, four = num
first

1

_

3

four

4

위와 같이 임시 변수로 사용하는 것 외에도 "_"는 인터프리터가 평가한 마지막 표현식의 결과를 나타내는 특수 변수로 사용될 수 있습니다. 그러므로 바로 직전 결과에 엑세스하려는 경우 편리합니다.

20+3

23

_

23

print(_)

23

list()

[]

다음은 직전 결과인 이름없는 빈 리스트에 새로운 요소를 첨가하기 위해 '_'를 사용합니다.

_.append(1)
_.append(2)
_.append(3)
_

[1, 2, 3]