확장 모듈 정의

CPython용 C 확장은 공유 라이브러리(예를 들어 리눅스의 .so 파일, 윈도우의 .pyd DLL)로, 파이썬 프로세스로 로드 가능하고(예를 들어 호환되는 컴파일러 설정으로 컴파일된) 초기화 함수를 익스포트합니다.

기본적으로 임포트 가능하려면(즉, importlib.machinery.ExtensionFileLoader에 의해), 공유 라이브러리는 sys.path 에 있어야 하고, 모듈 이름에 importlib.machinery.EXTENSION_SUFFIXES 에 나열된 확장자를 붙인 이름이어야 합니다.

참고

확장 모듈을 빌드, 패키징 및 배포하는 작업은 제삼자 도구를 사용하는 것이 가장 좋으며, 이 문서의 범위를 벗어납니다. 적합한 도구 중 하나는 Setuptools로, 문서는 https://setuptools.pypa.io/en/latest/setuptools.html 에서 찾을 수 있습니다.

일반적으로 초기화 함수는 PyModuleDef_Init() 을 사용하여 초기화된 모듈 정의를 반환합니다. 이를 통해 생성 과정을 여러 단계로 나눌 수 있습니다:

• 실질적인 코드가 실행되기 전에, 파이썬은 모듈이 지원하는 기능을 파악하고, 환경을 조정하거나 호환되지 않는 확장의 로드를 거부할 수 있습니다.

• 기본적으로 파이썬 자체가 모듈 객체를 생성합니다 – 즉, 클래스의 경우 object.__new__() 와 동등한 작업을 수행합니다. 또한 __package__ 와 __loader__ 같은 초기 어트리뷰트를 설정합니다.

• 이후 모듈 객체는 확장에 특화된 코드를 사용하여 초기화됩니다 – 클래스의 경우 __init__() 와 동등합니다.

이것은 초기화 함수가 완전히 구성된 모듈을 반환하는 레거시(하지만 여전히 지원되는) 단일 단계 초기화 방식과 구별하기 위해 다단계 초기화라고 합니다. 자세한 내용은 아래의 단일 단계 초기화 섹션을 참조하십시오.

버전 3.5에서 변경: 다단계 초기화 지원이 추가되었습니다 (PEP 489).

다중 모듈 인스턴스

기본적으로 확장 모듈은 싱글톤이 아닙니다. 예를 들어, sys.modules 항목이 제거되고 모듈이 다시 임포트되면 새 모듈 객체가 생성되고, 일반적으로 새 메서드와 형 객체로 채워집니다. 이전 모듈은 일반적인 가비지 컬렉션의 대상이 됩니다. 이는 순수 파이썬 모듈의 동작을 반영합니다.

추가 모듈 인스턴스는 서브 인터프리터 에서 또는 파이썬 런타임 재초기화(Py_Finalize() 와 Py_Initialize()) 후에 생성될 수 있습니다. 이 경우 모듈 인스턴스 간에 파이썬 객체를 공유하면 크래시나 정의되지 않은 동작이 발생할 가능성이 있습니다.

이러한 문제를 피하려면 확장 모듈의 각 인스턴스가 격리되어야 합니다: 한 인스턴스의 변경이 다른 인스턴스에 묵시적으로 영향을 주어서는 안 되며, 파이썬 객체에 대한 참조를 포함하여 모듈이 소유한 모든 상태는 특정 모듈 인스턴스에 한정되어야 합니다. 자세한 내용과 실용적인 안내는 Isolating Extension Modules를 참조하십시오.

이러한 문제를 피하는 더 간단한 방법은 반복 초기화 시 에러 발생시키기입니다.

모든 모듈은 서브 인터프리터를 지원하거나, 그렇지 않으면 지원하지 않음을 명시적으로 알려야 합니다. 이는 위에서 설명한 것처럼 격리 또는 반복 초기화 차단을 통해 보통 달성됩니다. 모듈은 Py_mod_multiple_interpreters 슬롯을 사용하여 메인 인터프리터로만 제한될 수도 있습니다.

초기화 함수

확장 모듈이 정의하는 초기화 함수의 시그니처는 다음과 같습니다:

PyObject *PyInit_modulename(void)

이름은 PyInit_<name> 이어야 하며, <name> 은 모듈 이름으로 대체됩니다.

ASCII만으로 구성된 이름의 모듈은 함수 이름이 PyInit_<name> 이어야 하며, <name> 은 모듈 이름으로 대체됩니다. 다단계 초기화 을 사용할 때는 ASCII가 아닌 모듈 이름도 허용됩니다. 이 경우 초기화 함수 이름은 PyInitU_<name> 이며, <name> 은 파이썬의 punycode 인코딩으로 인코딩되고 하이픈은 밑줄로 대체됩니다. 파이썬으로 표현하면:

def initfunc_name(name):
    try:
        suffix = b'_' + name.encode('ascii')
    except UnicodeEncodeError:
        suffix = b'U_' + name.encode('punycode').replace(b'-', b'_')
    return b'PyInit' + suffix

초기화 함수는 헬퍼 매크로를 사용하여 정의하는 것이 권장됩니다:

PyMODINIT_FUNC

확장 모듈 초기화 함수를 선언합니다. 이 매크로는:

• PyObject* 반환 형을 지정하고,

• 플랫폼에 필요한 특수 링크 선언을 추가하며,

• C++의 경우 함수를 extern "C" 로 선언합니다.

예를 들어, spam 이라는 모듈은 다음과 같이 정의됩니다:

static struct PyModuleDef spam_module = {
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "spam",
    ...
};

PyMODINIT_FUNC
PyInit_spam(void)
{
    return PyModuleDef_Init(&spam_module);
}

여러 초기화 함수를 정의하여 단일 공유 라이브러리에서 여러 모듈을 익스포트할 수 있습니다. 그러나 임포트하려면 심볼릭 링크나 커스텀 임포터를 사용해야 합니다. 기본적으로는 파일 이름에 해당하는 함수만 찾기 때문입니다. 자세한 내용은 PEP 489 의 단일 라이브러리 안의 다중 모듈 섹션을 참조하십시오.

초기화 함수는 일반적으로 모듈의 C 소스에서 static이 아닌 유일한 항목입니다.

다단계 초기화

일반적으로 초기화 함수 (PyInit_modulename)는 NULL이 아닌 m_slots 를 가진 PyModuleDef 인스턴스를 반환합니다. 반환되기 전에 PyModuleDef 인스턴스는 다음 함수를 사용하여 초기화되어야 합니다:

PyObject *PyModuleDef_Init(PyModuleDef *def)

Part of the 안정 ABI 버전 3.5 이후로.

모듈 정의기 형과 참조 횟수를 정확하게 보고하는 제대로 초기화된 파이썬 객체임을 보장해야 합니다.

에러가 발생하면 NULL 을, 그렇지 않으면 PyObject* 로 캐스팅된 def를 반환합니다.

이 함수 호출은 다단계 초기화 에 필요합니다. 다른 컨텍스트에서는 사용하지 않아야 합니다.

파이썬은 PyModuleDef 구조체가 정적으로 할당된다고 가정합니다. 이 함수는 새 참조 또는 빌린 참조를 반환할 수 있으며, 이 참조는 해제해서는 안 됩니다.

Added in version 3.5.

레거시 단일 단계 초기화

주의

단일 단계 초기화는 확장 모듈을 초기화하는 레거시 메커니즘으로, 알려진 단점과 설계상 결함이 있습니다. 확장 모듈 작성자는 대신 다단계 초기화를 사용하도록 권장됩니다.

단일 단계 초기화에서 초기화 함수는 (PyInit_modulename) 모듈 객체를 생성하고, 채워서 반환해야 합니다. 이는 보통 PyModule_Create() 와 PyModule_AddObjectRef() 같은 함수를 사용하여 수행됩니다.

단일 단계 초기화는 다음과 같은 점에서 기본 단계와 다릅니다:

• 단일 단계 모듈은 “싱글톤”이거나 오히려 “싱글톤”을 포함 합니다.

  모듈이 처음 초기화될 때, 파이썬은 모듈의 __dict__ 내용(즉, 일반적으로 모듈의 함수와 형)을 저장합니다.

  이후 임포트에서는 파이썬이 초기화 함수를 다시 호출하지 않습니다. 대신 새 __dict__ 를 가진 새 모듈 객체를 생성하고 저장된 내용을 복사합니다. 예를 들어, 함수 sum 과 예외 클래스 error 를 정의하는 단일 단계 모듈 _testsinglephase [1] 가 있다고 가정하면:

  >>> import sys
  >>> import _testsinglephase as one
  >>> del sys.modules['_testsinglephase']
  >>> import _testsinglephase as two
  >>> one is two
  False
  >>> one.__dict__ is two.__dict__
  False
  >>> one.sum is two.sum
  True
  >>> one.error is two.error
  True
  

  정확한 동작은 CPython 구현 세부 사항으로 간주해야 합니다.

• PyInit_modulename이 spec 인자를 받지 않는다는 사실을 우회하기 위해, 임포트 장치의 일부 상태가 저장되어 PyInit_modulename 호출 중에 생성되는 첫 번째 적합한 모듈에 적용됩니다. 구체적으로, 서브 모듈이 임포트될 때 이 메커니즘은 부모 패키지 이름을 모듈 이름 앞에 붙입니다.

  단일 단계 PyInit_modulename 함수는 다른 모듈 객체가 생성되기 전에 가능한 한 빨리 “자신의” 모듈 객체를 생성해야 합니다.

• ASCII가 아닌 모듈 이름(PyInitU_modulename)은 지원되지 않습니다.

• 단일 단계 모듈은 PyState_FindModule() 같은 모듈 조회 함수를 지원합니다.

[1]

_testsinglephase 는 CPython의 자체 테스트 스위트에서 사용되는 내부 모듈로, 설치 환경에 따라 포함될 수도 있고 포함되지 않을 수도 있습니다.