확장 모듈 정의¶

CPython용 C 확장은 공유 라이브러리(예를 들어 리눅스의 .so 파일, 윈도우의 .pyd DLL)로, 파이썬 프로세스에 로드 가능하며(예를 들어 호환되는 컴파일러 설정으로 컴파일됨), export hook 함수(또는 구형 스타일의 초기화 함수)를 내보냅니다.

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

참고

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

확장 내보내기 후크¶

Added in version 3.15: PyModExport_<name> 내보내기 후크 지원이 Python 3.15에서 추가되었습니다. 이전 방식의 모듈 정의도 여전히 가능합니다. 이전 파이썬 버전을 지원할 계획이라면 PyInit 함수 섹션이나 이 문서의 이전 버전을 참고하십시오.

내보내기 후크는 다음 시그니처를 가진 내보낸 함수여야 합니다.

PySlot *PyModExport_modulename(void)¶

ASCII로만 구성된 이름을 가진 모듈의 경우, 내보내기 후크 는 <name> 을 모듈 이름으로 대체한 PyModExport_{<name>}`으로 명명되어야 합니다.

ASCII가 아닌 모듈 이름의 경우, 내보내기 후크는 대신 PyModExportU_{<name>}`(U 에 주의)으로 명명되어야 하며, 여기서 <name> 은 하이픈을 밑줄로 대체하고 파이썬의 punycode 인코딩을 사용하여 인코딩됩니다. 파이썬에서는 다음과 같습니다.

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

내보내기(export) 후크는 슬롯 ID가 0 인 항목으로 끝나는 PySlot 항목의 배열을 반환합니다. 이 슬롯들은 모듈이 어떻게 생성되고 초기화되어야 하는지를 기술합니다.

이 배열은 인터프리터가 종료될 때까지 유효하고 변하지 않는 상태를 유지해야 합니다. 일반적으로 static 저장을 사용해야 합니다. 동적인 동작을 구현하려면 Py_mod_create 및 Py_mod_exec 슬롯을 사용하는 것이 좋습니다.

내보내기 후크는 실패를 알리기 위해 예외를 설정하고 NULL 을 반환할 수 있습니다.

도움말 매크로를 사용하여 내보내기 후크 함수를 정의하는 것이 권장됩니다:

PyMODEXPORT_FUNC¶

…의 일부 안정 ABI 버전 3.15 이후로.

확장 모듈 내보내기 후크를 선언합니다. 이 매크로는:

PySlot* 반환 타입을 지정하며,
플랫폼에 필요한 특수 링크 선언을 추가하며,
C++의 경우 함수를 extern "C" 로 선언합니다.

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

PyABIInfo_VAR(abi_info);

static PySlot spam_slots[] = {
    PySlot_STATIC_DATA(Py_mod_abi, &abi_info),
    PySlot_STATIC_DATA(Py_mod_name, "spam"),
    PySlot_FUNC(Py_mod_init, spam_init_function),
    ...
    PySlot_END
};

PyMODEXPORT_FUNC
PyModExport_spam(void)
{
    return spam_slots;
}

내보내기 후크는 일반적으로 모듈의 C 소스에서 정의되는 유일한 비(非)-static 항목입니다.

후크는 짧게 유지해야 합니다. 정적 배열을 return 하는 것 이상의 작업을 수행할 경우 몇 가지 주의 사항이 적용됩니다:

Python C API를 사용해야 하는 경우, 일반적인 ABI 불일치 상황에서 충돌이 발생하는 대신 예외를 발생시키기 위해 먼저 PyABIInfo_Check() 를 호출하는 것이 좋습니다.
내보내기 후크의 코드는 절대로 GIL 에 의존해서는 안 됩니다. Python의 free-threaded 빌드 는 후크가 반환된 후에만 Py_mod_gil 슬롯(또는 해당 슬롯이 없는지 여부)을 확인할 수 있습니다.
마찬가지로, Py_mod_multiple_interpreters 슬롯(또는 해당 슬롯이 없는지 여부)은 후크가 반환된 후에만 확인되므로, 후크는 어떤 서브 인터프리터에서도 호출될 수 있습니다.

예를 들어:

PyMODEXPORT_FUNC
PyModExport_modulename(void)
{
   if (PyABIInfo_Check(&abi_info, "modulename") < 0) {
      /* ABI 불일치. 발생한 예외를 조사하는 것은 안전하지 않습니다. */
      return NULL;
   }

   /* Python API 사용(최소한으로); GIL에 의존하지 마십시오. */

   return modulename_slots;
}

참고

여러 개의 내보내기 후크를 정의함으로써 단일 공유 라이브러리에서 여러 모듈을 내보낼 수 있습니다. 하지만 파이썬의 임포트 메커니즘은 파일 이름과 일치하는 함수만 찾으므로, 이들을 임포트하려면 사용자 정의 임포터나 적절한 이름으로 된 확장 파일의 복사본/링크가 필요합니다. 자세한 내용은 PEP 489 의 단일 라이브러리 내 여러 모듈 섹션을 참조하십시오.

다단계 초기화¶

확장 모듈을 생성하는 과정은 여러 단계를 거칩니다:

파이썬은 내보내기 후크를 찾아 호출하여 모듈을 생성하는 방법에 대한 정보를 가져옵니다.
실질적인 코드가 실행되기 전에, 파이썬은 모듈이 지원하는 기능을 판단하고 환경을 조정하거나 호환되지 않는 확장의 로드를 거부할 수 있습니다. Py_mod_abi, Py_mod_gil, Py_mod_multiple_interpreters 와 같은 슬롯들이 이 단계에 영향을 미칩니다.
기본적으로 파이썬은 모듈 객체를 생성합니다. 즉, 객체를 생성할 때 __new__() 를 호출하는 것과 동일한 작업을 수행합니다. 이 단계는 Py_mod_create 슬롯을 사용하여 재정의할 수 있습니다.
파이썬은 __package__ 및 __loader__ 와 같은 초기 모듈 어트리뷰트를 설정하고, 모듈 객체를 sys.modules 에 삽입합니다.
그 후 모듈 객체는 확장에 특화된 방식으로 초기화됩니다. 이는 객체를 생성할 때 __init__() 을 호출하거나 파이썬 언어 모듈에서 최상위 코드를 실행하는 것과 동일합니다. 이 동작은 Py_mod_exec 슬롯을 사용하여 정의됩니다.

이것은 초기화 함수가 완전히 구성된 모듈을 반환하는 레거시(그러나 여전히 지원되는) 단일 단계 초기화 와 구분하기 위해 다단계 초기화 라고 부릅니다.

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

다중 모듈 인스턴스¶

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

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

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

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

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

`PyInit` 함수¶

버전 3.15부터 약하게 폐지 <Soft deprecated>: 이 기능에 새로운 기능이 추가되지는 않겠지만, 제거할 계획도 없습니다.

PyModExport_modulename() 대신 확장 모듈은 다음과 같은 시그니처를 가진 구형 방식의 초기화 함수 를 정의할 수 있습니다.

PyObject *PyInit_modulename(void)¶

이름은 모듈 이름으로 대체된 PyInt_{<name>}`이어야 합니다. ASCII가 아닌 모듈 이름의 경우 대신 PyInitU_{<name>}` 을 사용하며, <name> 은 내보내기 후크 와 동일한 방식(즉, 언더바를 포함한 Punycode)으로 인코딩됩니다.

모듈이 PyInit_<name>`와 :samp:`PyModExport_<name>`을 모두 내보내는 경우, :samp:`PyInit_<name> 함수는 무시됩니다.

PyMODEXPORT_FUNC 와 마찬가지로, 도움말 매크로를 사용하여 초기화 함수를 정의하는 것이 권장됩니다:

PyMODINIT_FUNC¶

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

PyObject* 반환 형을 지정하고,
플랫폼에 필요한 특수 링크 선언을 추가하며,
C++의 경우 함수를 extern "C" 로 선언합니다.

일반적으로 초기화 함수(Py1nit_modulename)는 비어 있지 않은 m_slots 를 가진 PyModuleDef 인스턴스를 반환합니다. 이를 통해 파이썬은 다단계 초기화 를 사용할 수 있습니다.

반환되기 전에, PyModuleDef 인스턴스는 다음 함수를 사용하여 초기화되어야 합니다.

PyObject *PyModuleDef_Init(PyModuleDef *def)¶

…의 일부 안정 ABI 버전 3.5 이후로.

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

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

모듈 초기화 함수에서 PyModuleDef 를 반환하기 전에 이 함수를 호출해야 합니다. 다른 문맥에서는 사용해서는 안 됩니다.

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

Added in version 3.5.

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

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

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

레거시 단일 단계 초기화¶

버전 3.15부터 약하게 폐지 <Soft deprecated>: 단일 단계 초기화는 확장 모듈을 초기화하는 레거시 메커니즘으로, 알려진 단점과 설계상 결함이 있습니다. 확장 모듈 작성자는 대신 다단계 초기화를 사용하도록 권장됩니다.

그러나 이에 대한 지원을 제거할 계획은 없습니다.

단일 단계 초기화에서 구식 스타일의 초기화 함수 (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() 같은 모듈 조회 함수를 지원합니다.
모듈의 PyModuleDef.m_slots 은 NULL이어야 합니다.