함수 내부 검사

Beginner

This tutorial is from open-source community. Access the source code

소개

이 랩에서는 Python 함수의 내부 구조를 탐구하는 방법을 배우게 됩니다. Python 의 함수는 자체 속성과 메서드를 가진 객체이며, 이를 이해하면 함수가 어떻게 작동하는지에 대한 더 깊은 통찰력을 얻을 수 있습니다. 이러한 지식은 더 강력하고 적응력 있는 코드를 작성하는 데 도움이 될 것입니다.

함수 속성 및 프로퍼티를 검사하고, inspect 모듈을 사용하여 함수 시그니처를 검사하며, 이러한 검사 기술을 클래스 구현을 향상시키는 데 적용하는 방법을 배우게 됩니다. 수정할 파일은 structure.py입니다.

함수 속성 탐구

Python 에서 함수는 일급 객체로 간주됩니다. 이것이 의미하는 바는 무엇일까요? 실제 세계에서 책이나 펜과 같은 다양한 유형의 객체를 가지고 있는 것과 유사합니다. Python 에서 함수도 객체이며, 다른 객체와 마찬가지로 자체 속성 집합을 가지고 있습니다. 이러한 속성은 함수 이름, 정의된 위치, 구현 방식 등 함수에 대한 많은 유용한 정보를 제공할 수 있습니다.

Python 대화형 셸을 열어 탐구를 시작해 보겠습니다. 이 셸은 Python 코드를 즉시 작성하고 실행할 수 있는 놀이터와 같습니다. 이렇게 하려면 먼저 프로젝트 디렉토리로 이동한 다음 Python 인터프리터를 시작합니다. 터미널에서 실행할 명령어는 다음과 같습니다.

cd ~/project
python3

이제 Python 대화형 셸에 들어왔으니 간단한 함수를 정의해 보겠습니다. 이 함수는 두 개의 숫자를 받아 더합니다. 다음과 같이 정의할 수 있습니다.

def add(x, y):
    'Adds two things'
    return x + y

이 코드에서 add라는 함수를 만들었습니다. 두 개의 매개변수 xy를 받아 합계를 반환합니다. 문자열 'Adds two things'는 함수가 수행하는 작업을 문서화하는 데 사용되는 docstring 이라고 합니다.

dir() 을 사용하여 함수 속성 검사

Python 에서 dir() 함수는 유용한 도구입니다. 객체가 가진 모든 속성과 메서드의 목록을 가져오는 데 사용할 수 있습니다. add 함수가 어떤 속성을 가지고 있는지 확인하기 위해 사용해 보겠습니다. Python 대화형 셸에서 다음 코드를 실행합니다.

dir(add)

이 코드를 실행하면 긴 속성 목록이 표시됩니다. 다음은 출력의 예입니다.

['__annotations__', '__call__', '__class__', '__closure__', '__code__', '__defaults__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__get__', '__getattribute__', '__globals__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__kwdefaults__', '__le__', '__lt__', '__module__', '__name__', '__ne__', '__new__', '__qualname__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__']

이 목록은 add 함수와 관련된 모든 속성과 메서드를 보여줍니다.

기본 함수 정보에 접근

이제 몇 가지 기본 함수 속성을 자세히 살펴보겠습니다. 이러한 속성은 함수에 대한 중요한 정보를 알려줄 수 있습니다. Python 대화형 셸에서 다음 코드를 실행합니다.

print(add.__name__)
print(add.__module__)
print(add.__doc__)

이 코드를 실행하면 다음과 같은 출력이 표시됩니다.

add
__main__
Adds two things

각 속성이 무엇을 의미하는지 이해해 보겠습니다.

  • __name__: 이 속성은 함수의 이름을 제공합니다. 이 경우 함수 이름은 add입니다.
  • __module__: 함수가 정의된 모듈을 알려줍니다. 대화형 셸에서 코드를 실행할 때 모듈은 일반적으로 __main__입니다.
  • __doc__: 이것은 함수의 문서 문자열 또는 docstring 입니다. 함수가 수행하는 작업에 대한 간략한 설명을 제공합니다.

함수 코드 검사

함수의 __code__ 속성은 매우 흥미롭습니다. 바이트코드 및 기타 세부 정보를 포함하여 함수가 어떻게 구현되었는지에 대한 정보를 담고 있습니다. 여기서 무엇을 배울 수 있는지 살펴보겠습니다. Python 대화형 셸에서 다음 코드를 실행합니다.

print(add.__code__.co_varnames)
print(add.__code__.co_argcount)

출력은 다음과 같습니다.

('x', 'y')
2

다음은 이러한 속성이 알려주는 내용입니다.

  • co_varnames: 함수에서 사용되는 모든 지역 변수의 이름을 포함하는 튜플입니다. add 함수에서 지역 변수는 xy입니다.
  • co_argcount: 이 속성은 함수가 예상하는 인수의 수를 알려줍니다. add 함수는 두 개의 인수를 예상하므로 값은 2 입니다.

__code__ 객체의 더 많은 속성을 탐색하고 싶다면 dir() 함수를 다시 사용할 수 있습니다. 다음 코드를 실행합니다.

dir(add.__code__)

그러면 함수가 어떻게 구현되었는지에 대한 하위 수준 세부 정보를 포함하는 코드 객체의 모든 속성이 표시됩니다.

inspect 모듈 사용

Python 에서는 표준 라이브러리에 매우 유용한 inspect 모듈이 포함되어 있습니다. 이 모듈은 Python 의 라이브 객체에 대한 정보를 수집하는 데 도움이 되는 탐정 도구와 같습니다. 라이브 객체는 모듈, 클래스 및 함수와 같은 것일 수 있습니다. 객체의 속성을 수동으로 파고들어 정보를 찾는 대신, inspect 모듈은 함수의 속성을 이해하는 데 더 체계적이고 높은 수준의 방법을 제공합니다.

이 모듈이 어떻게 작동하는지 탐구하기 위해 동일한 Python 대화형 셸을 계속 사용해 보겠습니다.

함수 시그니처 (Function Signatures)

inspect.signature() 함수는 유용한 도구입니다. 함수를 전달하면 Signature 객체를 반환합니다. 이 객체는 함수의 매개변수에 대한 중요한 세부 정보를 담고 있습니다.

예를 들어 보겠습니다. add라는 함수가 있다고 가정해 보겠습니다. inspect.signature() 함수를 사용하여 시그니처를 얻을 수 있습니다.

import inspect
sig = inspect.signature(add)
print(sig)

이 코드를 실행하면 출력은 다음과 같습니다.

(x, y)

이 출력은 함수가 허용할 수 있는 매개변수를 알려주는 함수의 시그니처를 보여줍니다.

매개변수 세부 정보 검사

한 단계 더 나아가 함수의 각 매개변수에 대한 더 자세한 정보를 얻을 수 있습니다.

print(sig.parameters)

이 코드의 출력은 다음과 같습니다.

OrderedDict([('x', <Parameter "x">), ('y', <Parameter "y">)])

함수의 매개변수는 정렬된 딕셔너리에 저장됩니다. 때로는 매개변수의 이름만 관심 있을 수 있습니다. 이 정렬된 딕셔너리를 튜플로 변환하여 매개변수 이름만 추출할 수 있습니다.

param_names = tuple(sig.parameters)
print(param_names)

출력은 다음과 같습니다.

('x', 'y')

개별 매개변수 검사

각 개별 매개변수를 자세히 살펴볼 수도 있습니다. 다음 코드는 함수의 각 매개변수를 반복하고 이에 대한 몇 가지 중요한 세부 정보를 출력합니다.

for name, param in sig.parameters.items():
    print(f"Parameter: {name}")
    print(f"  Kind: {param.kind}")
    print(f"  Default: {param.default if param.default is not param.empty else 'No default'}")

이 코드는 각 매개변수에 대한 세부 정보를 보여줍니다. 매개변수의 종류 (위치 매개변수인지, 키워드 매개변수인지 등) 와 기본값이 있는 경우 기본값을 알려줍니다.

inspect 모듈에는 함수 인트로스펙션 (function introspection) 을 위한 다른 많은 유용한 함수가 있습니다. 다음은 몇 가지 예입니다.

  • inspect.getdoc(obj): 이 함수는 객체에 대한 문서 문자열을 검색합니다. 문서 문자열은 프로그래머가 객체가 수행하는 작업을 설명하기 위해 작성하는 메모와 같습니다.
  • inspect.getfile(obj): 객체가 정의된 파일을 찾는 데 도움이 됩니다. 객체의 소스 코드를 찾고 싶을 때 매우 유용할 수 있습니다.
  • inspect.getsource(obj): 이 함수는 객체의 소스 코드를 가져옵니다. 객체가 정확히 어떻게 구현되었는지 확인할 수 있습니다.

클래스에서 함수 검사 적용

이제 함수 검사에 대해 배운 내용을 가져와 클래스 구현을 개선하는 데 사용해 보겠습니다. 함수 검사를 사용하면 함수 내부를 살펴보고 함수가 사용하는 매개변수와 같은 구조를 이해할 수 있습니다. 이 경우, 클래스 코드를 더 효율적이고 오류 발생 가능성이 적도록 만드는 데 사용합니다. Structure 클래스를 수정하여 __init__ 메서드 시그니처에서 필드 이름을 자동으로 감지할 수 있도록 합니다.

Structure 클래스 이해

structure.py 파일에는 Structure 클래스가 포함되어 있습니다. 이 클래스는 기본 클래스로 작동합니다. 즉, 다른 클래스가 이 클래스에서 상속받아 구조화된 데이터 객체를 만들 수 있습니다. 현재, Structure에서 상속받는 클래스에서 생성된 객체의 속성을 정의하려면 _fields 클래스 변수를 설정해야 합니다.

편집기에서 파일을 열어 보겠습니다. 다음 명령을 사용하여 프로젝트 디렉토리로 이동합니다.

cd ~/project

이 명령을 실행하면 WebIDE 내의 structure.py 파일에서 기존 Structure 클래스를 찾고 볼 수 있습니다.

Stock 클래스 생성

Structure 클래스에서 상속받는 Stock 클래스를 만들어 보겠습니다. 상속은 Stock 클래스가 Structure 클래스의 모든 기능을 얻고 자체 기능을 추가할 수도 있음을 의미합니다. structure.py 파일의 끝에 다음 코드를 추가합니다.

class Stock(Structure):
    _fields = ('name', 'shares', 'price')

    def __init__(self, name, shares, price):
        self._init()

그러나 이 접근 방식에는 문제가 있습니다. _fields 튜플과 __init__ 메서드를 동일한 매개변수 이름으로 모두 정의해야 합니다. 이는 본질적으로 동일한 정보를 두 번 작성하고 있기 때문에 중복됩니다. 다른 항목을 변경할 때 하나를 업데이트하는 것을 잊으면 오류가 발생할 수 있습니다.

set_fields 클래스 메서드 추가

이 문제를 해결하기 위해 Structure 클래스에 set_fields 클래스 메서드를 추가합니다. 이 메서드는 __init__ 시그니처에서 필드 이름을 자동으로 감지합니다. Structure 클래스에 추가해야 하는 코드는 다음과 같습니다.

@classmethod
def set_fields(cls):
    ## Get the signature of the __init__ method
    import inspect
    sig = inspect.signature(cls.__init__)

    ## Get parameter names, skipping 'self'
    params = list(sig.parameters.keys())[1:]

    ## Set _fields attribute on the class
    cls._fields = tuple(params)

이 메서드는 Python 에서 함수 및 클래스와 같은 객체에 대한 정보를 얻는 데 강력한 도구인 inspect 모듈을 사용합니다. 먼저, __init__ 메서드의 시그니처를 가져옵니다. 그런 다음, 매개변수 이름을 추출하지만 self 매개변수는 건너뜁니다. self는 인스턴스 자체를 참조하는 Python 클래스의 특수 매개변수이기 때문입니다. 마지막으로, 이러한 매개변수 이름으로 _fields 클래스 변수를 설정합니다.

Stock 클래스 수정

이제 set_fields 메서드가 있으므로 Stock 클래스를 단순화할 수 있습니다. 이전 Stock 클래스 코드를 다음으로 바꿉니다.

class Stock(Structure):
    def __init__(self, name, shares, price):
        self._init()

## Call set_fields to automatically set _fields from __init__
Stock.set_fields()

이런 방식으로 _fields 튜플을 수동으로 정의할 필요가 없습니다. set_fields 메서드가 이를 처리합니다.

수정된 클래스 테스트

수정된 클래스가 제대로 작동하는지 확인하기 위해 간단한 테스트 스크립트를 만들겠습니다. test_structure.py라는 새 파일을 만들고 다음 코드를 추가합니다.

from structure import Stock

def test_stock():
    ## Create a Stock object
    s = Stock(name='GOOG', shares=100, price=490.1)

    ## Test string representation
    print(f"Stock representation: {s}")

    ## Test attribute access
    print(f"Name: {s.name}")
    print(f"Shares: {s.shares}")
    print(f"Price: {s.price}")

    ## Test attribute modification
    s.shares = 50
    print(f"Updated shares: {s.shares}")

    ## Test attribute error
    try:
        s.share = 50  ## Misspelled attribute
        print("Error: Did not raise AttributeError")
    except AttributeError as e:
        print(f"Correctly raised: {e}")

if __name__ == "__main__":
    test_stock()

이 테스트 스크립트는 Stock 객체를 생성하고, 문자열 표현을 테스트하고, 속성에 액세스하고, 속성을 수정하고, 오타가 있는 속성에 액세스하여 올바른 오류가 발생하는지 확인합니다.

테스트 스크립트를 실행하려면 다음 명령을 사용합니다.

python3 test_structure.py

다음과 유사한 출력이 표시됩니다.

Stock representation: Stock('GOOG',100,490.1)
Name: GOOG
Shares: 100
Price: 490.1
Updated shares: 50
Correctly raised: No attribute share

작동 방식

  1. set_fields 메서드는 inspect.signature()를 사용하여 __init__ 메서드에서 매개변수 이름을 가져옵니다. 이 함수는 __init__ 메서드의 매개변수에 대한 자세한 정보를 제공합니다.
  2. 그런 다음, 이러한 매개변수 이름을 기반으로 _fields 클래스 변수를 자동으로 설정합니다. 따라서 동일한 매개변수 이름을 두 군데에 작성할 필요가 없습니다.
  3. 이렇게 하면 일치하는 매개변수 이름으로 _fields__init__를 모두 수동으로 정의할 필요가 없어집니다. __init__ 메서드의 매개변수를 변경하면 _fields가 자동으로 업데이트되므로 코드를 더 쉽게 유지 관리할 수 있습니다.

이 접근 방식은 함수 검사를 사용하여 코드를 더 쉽게 유지 관리하고 오류 발생 가능성을 줄입니다. 이는 런타임에 객체를 검사하고 수정할 수 있는 Python 의 인트로스펙션 (introspection) 기능을 실용적으로 적용한 것입니다.

요약

이 랩에서는 Python 함수의 내부를 검사하는 방법을 배웠습니다. dir()과 같은 메서드를 사용하여 함수 속성을 직접 검사하고 __name__, __doc__, __code__와 같은 특수 속성에 액세스했습니다. 또한 inspect 모듈을 사용하여 함수 시그니처 (function signatures) 및 매개변수에 대한 구조화된 정보를 얻었습니다.

함수 검사는 더 동적이고 유연하며 유지 관리 가능한 코드를 작성할 수 있게 해주는 강력한 Python 기능입니다. 런타임에 함수 속성을 검사하고 조작하는 기능은 메타 프로그래밍 (metaprogramming), 자체 문서화 코드 생성 및 고급 프레임워크 구축을 위한 가능성을 제공합니다.