공통 객체 구조체¶

파이썬의 객체 형 정의에 사용되는 많은 구조체가 있습니다. 이 섹션에서는 이러한 구조체와 사용 방법에 관해 설명합니다.

기본 객체 형과 매크로¶

모든 파이썬 객체는 궁극적으로 객체의 메모리 표현의 처음에서 적은 수의 필드를 공유합니다. 이들은 PyObject와 PyVarObject 형으로 표시되며, 다른 모든 파이썬 객체의 정의에서, 직접 또는 간접적으로, 사용되는 일부 매크로의 확장을 통해 정의됩니다. 추가 매크로는 참조 횟수에서 찾을 수 있습니다.

type PyObject¶

…의 일부 안정 ABI (see below).

All object types are extensions of this type. This is a type which contains the information Python needs to treat a pointer to an object as an object. In a normal “release” build, it contains only the object’s reference count and a pointer to the corresponding type object. Nothing is actually declared to be a PyObject, but every pointer to a Python object can be cast to a PyObject*.

멤버에 직접 접근해서는 안 됩니다. 대신 Py_REFCNT 및 Py_TYPE 과 같은 매크로를 사용하십시오.

Free-Threaded 빌드용 Stable ABI (abi3t)에서 이 구조체는 불투명(opaque)하며, 파이썬 버전에 따라 크기와 레이아웃이 변경될 수 있습니다. non-free-threaded 빌드용 Stable ABI(abi3)에서는 ob_refcnt 및 ob_type 필드를 사용할 수 있지만, 이를 직접 사용하는 것은 권장되지 않습니다.

Py_ssize_t ob_refcnt¶

…의 일부 안정 ABI.

Py_REFCNT 에 의해 반환되는 객체의 참조 횟수입니다. 이 필드를 직접 사용하지 마십시오. 대신 Py_REFCNT, Py_INCREF() 및 Py_DecRef() 와 같은 함수와 매크로를 사용하십시오.

필드 형은 빌드 구성 및 플랫폼에 따라 Py_ssize_t 와 다를 수 있습니다.

PyTypeObject *ob_type¶: …의 일부 안정 ABI.
객체의 형입니다. 이 필드를 직접 사용하지 마십시오. 대신 Py_TYPE 과 Py_SET_TYPE() 을 사용하십시오.

PyMutex ob_mutex¶

A per-object lock, present only in the free-threaded build (when Py_GIL_DISABLED is defined).

이 필드는 critical section API용으로 예약됨 (Py_BEGIN_CRITICAL_SECTION / Py_END_CRITICAL_SECTION). PyMutex_Lock 을 사용하여 이 필드를 직접 잠그지 마십시오. 그렇게 하면 데드락이 발생할 수 있습니다. 자체적인 잠금이 필요한 경우, 객체 구조체에 별도의 PyMutex 필드를 추가하십시오.

Added in version 3.13.

type PyVarObject¶

…의 일부 안정 ABI (see below).

ob_size 필드를 추가한 PyObject 의 확장형입니다. 이는 길이(length) 개념을 가진 객체를 위해 설계되었습니다.

PyObject 와 마찬가지로, 멤버에 직접 접근해서는 안 됩니다. 대신 Py_SIZE, Py_REFCNT 및 Py_TYPE 과 같은 매크로를 사용하십시오.

Free-Threaded 빌드용 Stable ABI (abi3t)에서 이 구조체는 불투명하며, 파이썬 버전에 따라 크기와 레이아웃이 변경될 수 있습니다. non-free-threaded 빌드용 Stable ABI(abi3)에서는 ob_base 및 ob_size 필드를 사용할 수 있지만, 이를 직접 사용하는 것은 권장되지 않습니다.

PyObject ob_base¶: …의 일부 안정 ABI.
공통 객체 헤더입니다. 일반적으로 이 필드에 직접 접근하지 않으며, 대신 PyVarObject 를 PyObject 로 캐스팅하여 사용합니다.

Py_ssize_t ob_size¶

…의 일부 안정 ABI.

객체의 내부 구현 세부 사항으로 간주되는 크기 필드입니다.

이 필드를 직접 사용하지 마십시오. 대신 Py_SIZE 를 사용하십시오.

PyObject_NewVar() 과 같은 객체 생성 함수는 일반적으로 이 필드를 요청된 크기(항목 수)로 설정합니다. 생성 후에는 Py_SET_SIZE 를 사용하여 ob_size 에 임의의 값을 저장할 수 있습니다.

Python 함수 len() 이 반환하는 것과 같이 공개적으로 노출된 객체의 길이를 가져오려면 대신 PyObject_Length() 를 사용하십시오.

PyObject_HEAD¶

길이가 변하지 않는 객체를 나타내는 새로운 형을 선언할 때 사용되는 매크로입니다. PyObject_HEAD 매크로는 다음과 같이 확장됩니다:

PyObject ob_base;

위의 PyObject 설명서를 참조하십시오.

PyObject_VAR_HEAD¶

인스턴스마다 길이가 다른 객체를 나타내는 새로운 형을 선언할 때 사용되는 매크로입니다. PyObject_VAR_HEAD 매크로는 다음과 같이 확장됩니다:

PyVarObject ob_base;

위의 PyVarObject 설명서를 참조하십시오.

PyTypeObject PyBaseObject_Type¶: …의 일부 안정 ABI.
다른 모든 객체의 기본 클래스로, 파이썬의 object 와 동일합니다.

int Py_Is(PyObject *x, PyObject *y)¶: …의 일부 안정 ABI 버전 3.10 이후로.
x 객체가 y 객체인지 확인하며, 파이썬의 x is y 와 동일합니다.

Added in version 3.10.

int Py_IsNone(PyObject *x)¶: …의 일부 안정 ABI 버전 3.10 이후로.
객체가 None 싱글톤인지 확인하며, 파이썬의 x is None 과 동일합니다.

Added in version 3.10.

int Py_IsTrue(PyObject *x)¶: …의 일부 안정 ABI 버전 3.10 이후로.
객체가 True 싱글톤인지 확인하며, 파이썬의 x is True 와 동일합니다.

Added in version 3.10.

int Py_IsFalse(PyObject *x)¶: …의 일부 안정 ABI 버전 3.10 이후로.
객체가 False 싱글톤인지 확인하며, 파이썬의 x is False 와 동일합니다.

Added in version 3.10.

PyTypeObject *Py_TYPE(PyObject *o)¶

반환값: 빌린 참조. …의 일부 안정 ABI 버전 3.14 이후로.

파이썬 객체 o 의 형을 가져옵니다.

반환된 참조는 o 로부터의 빌린 참조 입니다. Py_DECREF() 또는 이와 유사한 함수로 해제하지 마십시오.

버전 3.11에서 변경: Py_TYPE() 이 인라인 정적 함수로 변경되었습니다. 매개 변수 형이 더 이상 const PyObject* 가 아닙니다.

int Py_IS_TYPE(PyObject *o, PyTypeObject *type)¶: …의 일부 안정 ABI 버전 3.15 이후로.
객체 o의 형이 type이면 0이 아닌 값을 반환합니다. 그렇지 않으면 0을 반환합니다. Py_TYPE(o) == type과 동등합니다.

Added in version 3.9.

void Py_SET_TYPE(PyObject *o, PyTypeObject *type)¶

어떠한 검사나 참조 횟수 계산 없이 객체 o 의 형을 type 으로 설정합니다.

이것은 매우 낮은 수준의 작업입니다. 대신 PyObject_SetAttrString() 또는 이와 유사한 함수를 사용하여 파이썬 속성 __class__ 을 설정하는 것을 고려하십시오.

호환되지 않는 형을 할당하면 정의되지 않은 동작이 발생할 수 있음에 주의하십시오.

type 이 힙 형 인 경우 호출자는 그것에 대한 새로운 참조를 생성해야 합니다. 마찬가지로 o 의 이전 형이 힙 형인 경우, 호출자는 해당 형에 대한 참조를 해제해야 합니다.

Added in version 3.9.

Py_ssize_t Py_SIZE(PyVarObject *o)¶: …의 일부 안정 ABI 버전 3.15 이후로.
o 의 ob_size 필드를 가져옵니다.

버전 3.11에서 변경: Py_SIZE() 가 인라인 정적 함수로 변경되었습니다. 매개 변수 형이 더 이상 const PyVarObject* 가 아닙니다.

void Py_SET_SIZE(PyVarObject *o, Py_ssize_t size)¶: …의 일부 안정 ABI 버전 3.15 이후로.
o 의 ob_size 필드를 size 로 설정합니다.

Added in version 3.9.

PyObject_HEAD_INIT(type)¶

이것은 새로운 PyObject 형의 초기화 값으로 확장되는 매크로입니다. 이 매크로는 다음으로 확장됩니다:

_PyObject_EXTRA_INIT
1, type,

PyVarObject_HEAD_INIT(type, size)¶

이것은 ob_size 필드를 포함하여, 새로운 PyVarObject 형의 초기화 값으로 확장되는 매크로입니다. 이 매크로는 다음으로 확장됩니다:

_PyObject_EXTRA_INIT
1, type, size,

함수와 메서드 구현¶

type PyCFunction¶

…의 일부 안정 ABI.

대부분 파이썬 콜러블을 C로 구현하는 데 사용되는 함수 형. 이 형의 함수는 두 개의 PyObject* 매개 변수를 취하고 하나의 값을 반환합니다. 반환 값이 NULL이면, 예외가 설정되어 있어야 합니다. NULL이 아니면, 반환 값은 파이썬에 노출된 함수의 반환 값으로 해석됩니다. 함수는 새로운 참조를 반환해야 합니다.

함수 서명은 다음과 같습니다:

PyObject *PyCFunction(PyObject *self,
                      PyObject *args);

type PyCFunctionWithKeywords¶

…의 일부 안정 ABI.

서명이 METH_VARARGS | METH_KEYWORDS 인 파이썬 콜러블을 C로 구현하는 데 사용되는 함수 형. 함수 서명은 다음과 같습니다:

PyObject *PyCFunctionWithKeywords(PyObject *self,
                                  PyObject *args,
                                  PyObject *kwargs);

type PyCFunctionFast¶

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

서명이 METH_FASTCALL 인 파이썬 콜러블을 C로 구현하는 데 사용되는 함수 형. 함수 서명은 다음과 같습니다:

PyObject *PyCFunctionFast(PyObject *self,
                          PyObject *const *args,
                          Py_ssize_t nargs);

type PyCFunctionFastWithKeywords¶

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

서명이 METH_FASTCALL | METH_KEYWORDS 인 파이썬 콜러블을 C로 구현하는 데 사용되는 함수 형. 함수 서명은 다음과 같습니다:

PyObject *PyCFunctionFastWithKeywords(PyObject *self,
                                      PyObject *const *args,
                                      Py_ssize_t nargs,
                                      PyObject *kwnames);

type PyCMethod¶

서명이 METH_METHOD | METH_FASTCALL | METH_KEYWORDS 인 파이썬 콜러블을 C로 구현하는 데 사용되는 함수 형. 함수 서명은 다음과 같습니다:

PyObject *PyCMethod(PyObject *self,
                    PyTypeObject *defining_class,
                    PyObject *const *args,
                    Py_ssize_t nargs,
                    PyObject *kwnames)

Added in version 3.9.

type PyMethodDef¶

…의 일부 안정 ABI (모든 멤버 포함).

확장형의 메서드를 기술하는 데 사용되는 구조체. 이 구조체에는 네 개의 필드가 있습니다:

const char *ml_name¶

메서드의 이름.

NULL 인 ml_name 은 PyMethodDef 배열의 끝을 나타냅니다.

PyCFunction ml_meth¶: C 구현에 대한 포인터.

int ml_flags¶: 호출 구성 방법을 나타내는 플래그 비트.

const char *ml_doc¶: 독스트링의 내용을 가리킵니다.

ml_meth는 C 함수 포인터입니다. 함수는 형이 다를 수 있지만, 항상 PyObject*를 반환합니다. 함수가 PyCFunction이 아니면, 컴파일러는 메서드 테이블에서 캐스트를 요구합니다. PyCFunction이 첫 번째 매개 변수를 PyObject*로 정의하더라도, 일반적으로 메서드 구현은 self 객체의 특정 C 형을 사용합니다.

ml_flags 필드는 다음 플래그를 포함 할 수 있는 비트 필드입니다. 개별 플래그는 호출 규칙이나 바인딩 규칙을 나타냅니다.

다음과 같은 호출 규칙이 있습니다:

METH_VARARGS¶: …의 일부 안정 ABI.
이는 메서드가 PyCFunction 형인 일반적인 호출 규칙입니다. 함수는 두 개의 PyObject* 값을 기대합니다. 첫 번째는 메서드의 self 객체입니다; 모듈 함수의 경우, 모듈 객체입니다. 두 번째 매개 변수(종종 args라고 합니다)는 모든 인자를 나타내는 튜플 객체입니다. 이 매개 변수는 일반적으로 PyArg_ParseTuple()이나 PyArg_UnpackTuple()을 사용하여 처리됩니다.

METH_KEYWORDS¶: 다른 플래그와 다음과 같은 특정 조합으로만 사용될 수 있습니다: METH_VARARGS | METH_KEYWORDS, METH_FASTCALL | METH_KEYWORDS 및 METH_METHOD | METH_FASTCALL | METH_KEYWORDS.

METH_VARARGS | METH_KEYWORDS: 이러한 플래그가 있는 메서드는 PyCFunctionWithKeywords 형이어야 합니다. 이 함수는 세 개의 매개 변수를 기대합니다: self, args, kwargs. 여기서 kwargs는 모든 키워드 인자의 딕셔너리이거나 키워드 인자가 없으면 NULL일 수 있습니다. 매개 변수는 일반적으로 PyArg_ParseTupleAndKeywords()를 사용하여 처리됩니다.

METH_FASTCALL¶: …의 일부 안정 ABI 버전 3.10 이후로.
위치 인자만 지원하는 빠른 호출 규칙. 메서드의 형은 PyCFunctionFast 입니다. 첫 번째 매개 변수는 self이고, 두 번째 매개 변수는 인자를 나타내는 PyObject* 값의 C 배열이며, 세 번째 매개 변수는 인자 수(배열의 길이)입니다.

Added in version 3.7.

버전 3.10에서 변경: METH_FASTCALL은 이제 안정 API의 일부입니다.

METH_FASTCALL | METH_KEYWORDS: PyCFunctionFastWithKeywords 형의 메서드를 사용하여, 키워드 인자도 지원하는 METH_FASTCALL의 확장. 키워드 인자는 벡터콜(vectorcall) 프로토콜과 같은 방식으로 전달됩니다: 추가의 네 번째 PyObject* 매개 변수가 있는데, 키워드 인자의 이름(문자열임이 보장됩니다)을 나타내는 튜플이거나 키워드가 없으면 NULL일 수 있습니다. 키워드 인자의 값은 위치 인자 다음에 args 배열에 저장됩니다.

Added in version 3.7.

METH_METHOD¶: …의 일부 안정 ABI 버전 3.7 이후로.
다른 플래그와 다음과 같은 조합으로만 사용될 수 있습니다: METH_METHOD | METH_FASTCALL | METH_KEYWORDS.

METH_METHOD | METH_FASTCALL | METH_KEYWORDS

정의하는 클래스(defining class), 즉, 문제의 메서드를 포함하는 클래스를 지원하는 METH_FASTCALL | METH_KEYWORDS의 확장. 정의하는 클래스는 Py_TYPE(self)의 슈퍼 클래스일 수 있습니다.

메서드는 PyCMethod 형이어야 하는데, self 뒤에 defining_class 인자가 추가된 METH_FASTCALL | METH_KEYWORDS와 같습니다.

Added in version 3.9.

METH_NOARGS¶

…의 일부 안정 ABI.

매개 변수가 없는 메서드는 METH_NOARGS 플래그로 나열되어 있으면, 인자가 주어졌는지 확인할 필요가 없습니다. PyCFunction 형이어야 합니다. 첫 번째 매개 변수의 이름은 일반적으로 self이며 모듈이나 객체 인스턴스에 대한 참조를 보유합니다. 모든 경우에 두 번째 매개 변수는 NULL입니다.

함수는 2개의 매개 변수를 가져야 합니다. 두 번째 매개 변수가 사용되지 않으므로, 컴파일러 경고를 방지하기 위해 Py_UNUSED 를 사용할 수 있습니다.

METH_O¶: …의 일부 안정 ABI.
"O" 인자로 PyArg_ParseTuple()을 호출하는 대신, 단일 객체 인자가 있는 메서드는 METH_O 플래그로 나열 할 수 있습니다. PyCFunction 형이고, self 매개 변수와 단일 인자를 나타내는 PyObject* 매개 변수를 갖습니다.

이 두 상수는 호출 규칙을 나타내는 데 사용되지 않고 클래스 메서드와 함께 사용할 때의 바인딩을 나타냅니다. 이들은 모듈용으로 정의된 함수에는 사용할 수 없습니다. 특정 메서드에 대해 설정할 수 있는 플래그는 최대 하나입니다.

METH_CLASS¶: …의 일부 안정 ABI.
메서드에 인스턴스가 아닌 형 객체가 첫 번째 매개 변수로 전달됩니다. 이는 @classmethod 내장 데코레이터를 사용할 때 생성되는 것과 유사한 클래스 메서드(class methods) 를 만드는 데 사용됩니다.

METH_STATIC¶: …의 일부 안정 ABI.
메서드에 인스턴스가 아닌 NULL 이 첫 번째 매개 변수로 전달됩니다. 이는 @staticmethod 내장 데코레이터를 사용할 때 생성되는 것과 유사한 정적 메서드(static methods) 를 만드는 데 사용됩니다.

하나의 다른 상수는 같은 메서드 이름을 가진 다른 정의 대신 메서드가 로드되는지를 제어합니다.

METH_COEXIST¶: …의 일부 안정 ABI.
기존 정의 대신 메서드가 로드됩니다. METH_COEXIST가 없으면, 기본값은 반복되는 정의를 건너뛰는 것입니다. 슬롯 래퍼가 메서드 테이블 전에 로드되므로, 예를 들어 sq_contains 슬롯의 존재는 __contains__()라는 래핑 된 메서드를 생성하고 같은 이름의 해당 PyCFunction을 로드하지 않습니다. 플래그가 정의되면, PyCFunction이 래퍼 객체 자리에 로드되고 슬롯과 공존합니다. 이는 PyCFunction에 대한 호출이 래퍼 객체 호출보다 최적화되어 있기 때문에 유용합니다.

PyTypeObject PyCMethod_Type¶: 파이썬 C 메서드 객체에 해당하는 형 객체입니다. 파이썬 계층에서는 types.BuiltinMethodType 으로 사용 가능합니다.

int PyCMethod_Check(PyObject *op)¶: op 이 PyCMethod_Type 형이거나 그 하위 형인 경우 참을 반환합니다. 이 함수는 항상 성공합니다.

int PyCMethod_CheckExact(PyObject *op)¶: 이는 PyCMethod_Check() 와 동일하지만, 하위 형은 고려하지 않습니다.

PyObject *PyCMethod_New(PyMethodDef *ml, PyObject *self, PyObject *module, PyTypeObject *cls)¶

반환값: 새 참조. …의 일부 안정 ABI 버전 3.9 이후로.

ml 을 파이썬 callable 객체로 변환합니다. 호출자는 ml 이 callable 보다 오래 유지되도록 보장해야 합니다. 일반적으로 ml 은 정적 변수로 정의됩니다.

self 매개 변수는 호출 시 ml->ml_meth 에 있는 C 함수의 self 인자로 전달됩니다. self 는 NULL 일 수 있습니다.

callable 객체의 __module__ 속성을 제공된 module 인자로 설정할 수 있습니다. module 은 함수가 정의된 모듈의 이름으로 사용될 파이썬 문자열이어야 합니다. 사용할 수 없는 경우, None 또는 NULL 로 설정할 수 있습니다.

function.__module__

cls 매개 변수는 C 함수의 defining_class 인자로 전달됩니다. ml->ml_flags 에 METH_METHOD 가 설정된 경우 반드시 설정해야 합니다.

Added in version 3.9.

PyTypeObject PyCFunction_Type¶: …의 일부 안정 ABI.
파이썬 C 함수 객체에 해당하는 형 객체입니다. 파이썬 계층에서는 types.BuiltinFunctionType 으로 사용 가능합니다.

int PyCFunction_Check(PyObject *op)¶: op 이 PyCFunction_Type 형이거나 그 하위 형인 경우 참을 반환합니다. 이 함수는 항상 성공합니다.

int PyCFunction_CheckExact(PyObject *op)¶: 이는 PyCFunction_Check() 와 동일하지만, 하위 형은 고려하지 않습니다.

PyObject *PyCFunction_NewEx(PyMethodDef *ml, PyObject *self, PyObject *module)¶: 반환값: 새 참조. …의 일부 안정 ABI.
PyCMethod_New(ml, self, module, NULL) 와 동일합니다.

PyObject *PyCFunction_New(PyMethodDef *ml, PyObject *self)¶: 반환값: 새 참조. …의 일부 안정 ABI 버전 3.4 이후로.
PyCMethod_New(ml, self, NULL, NULL) 와 동일합니다.

int PyCFunction_GetFlags(PyObject *func)¶

…의 일부 안정 ABI.

func 에 설정된 플래그를 ml_flags 로 전달되었던 상태 그대로 가져옵니다.

func 이 C 함수 객체가 아니면 예외와 함께 실패합니다. func 은 NULL 이어서는 안 됩니다.

이 함수는 성공 시 함수의 플래그를 반환하고, 실패 시 예외와 함께 -1 을 반환합니다.

int PyCFunction_GET_FLAGS(PyObject *func)¶: 이것은 PyCFunction_GetFlags() 와 동일하지만, 오류나 형 검사를 수행하지 않습니다.

PyCFunction PyCFunction_GetFunction(PyObject *func)¶

…의 일부 안정 ABI.

func 의 함수 포인터를 ml_meth 에 전달되었던 상태 그대로 가져옵니다.

func 이 C 함수 객체가 아니면 예외와 함께 실패합니다. func 은 NULL 이어서는 안 됩니다.

이 함수는 성공 시 함수 포인터를 반환하고, 실패 시 예외와 함께 NULL 을 반환합니다.

int PyCFunction_GET_FUNCTION(PyObject *func)¶: 이것은 PyCFunction_GetFunction() 과 동일하지만, 오류나 형 검사를 수행하지 않습니다.

PyObject *PyCFunction_GetSelf(PyObject *func)¶

…의 일부 안정 ABI.

func 의 “self” 객체를 가져옵니다. 이는 PyCFunction 의 첫 번째 인자로 전달될 객체입니다. PyModuleDef 에 대한 PyMethodDef 를 통해 생성된 C 함수 객체의 경우, 이 값은 결과 모듈 객체입니다.

func 이 C 함수 객체가 아니면 예외와 함께 실패합니다. func 은 NULL 이어서는 안 됩니다.

이 함수는 성공 시 “self” 객체에 대한 빌린 참조 를 반환하고, 실패 시 예외와 함께 NULL 을 반환합니다.

PyObject *PyCFunction_GET_SELF(PyObject *func)¶: 이것은 PyCFunction_GetSelf() 와 동일하지만, 오류나 형 검사를 수행하지 않습니다.

확장형의 어트리뷰트 액세스¶

type PyMemberDef¶

…의 일부 안정 ABI (모든 멤버 포함).

C 구조체 멤버에 해당하는 형의 어트리뷰트를 기술하는 구조체. 클래스를 정의할 때, 이 구조체들의 NULL-종료 배열을 tp_members 슬롯에 넣습니다.

필드는 순서대로 다음과 같습니다:

const char *name¶

멤버의 이름입니다. NULL 값은 PyMemberDef[] 배열의 끝을 나타냅니다.

문자열은 정적이어야 하며, 복사본이 생성되지 않습니다.

int type¶: C 구조체 내 멤버의 형입니다. 가능한 값은 멤버 유형 를 참조하십시오.

Py_ssize_t offset¶: 멤버가 형의 객체 구조체에 위치하는 바이트 단위의 오프셋.

int flags¶: 멤버 플래그 중 하나 이상을 비트별 OR로 결합한 값입니다.

const char *doc¶: 독스트링 또는 NULL. 문자열은 정적이어야 하며, 복사본이 생성되지 않습니다. 일반적으로 PyDoc_STR 을 사용하여 정의합니다.

기본값(즉, flags 가 0 일 때)으로, 멤버는 읽기 및 쓰기 액세스를 모두 허용합니다. 읽기 전용 액세스를 위해서는 Py_READONLY 플래그를 사용하십시오. Py_T_STRING 과 같은 특정 타입은 Py_READONLY 를 암시합니다. Py_T_OBJECT_EX (그리고 레거시 T_OBJECT) 멤버만 삭제될 수 있습니다.

힙에 할당된 형(PyType_FromSpec() 등을 사용하여 생성됨)의 경우, PyMemberDef 는 타입 객체의 tp_vectorcall_offset 에 해당하는 특별한 멤버인 "__vectorcalloffset__" 정의를 포함할 수 있습니다. 이 멤버는 반드시 Py_T_PYSSIZET 으로 정의되어야 하며, Py_READONLY 또는 Py_READONLY | Py_RELATIVE_OFFSET 중 하나여야 합니다. 예시:

static PyMemberDef spam_type_members[] = {
    {"__vectorcalloffset__", Py_T_PYSSIZET,
     offsetof(Spam_object, vectorcall), Py_READONLY},
    {NULL}  /* Sentinel */
};

( offsetof() 를 위해서는 <stddef.h> 를 포함해야 할 수 있습니다.)

tp_dictoffset 및 tp_weaklistoffset 와 같은 레거시 오프셋은 "__dictoffset__" 및 "__weaklistoffset__" 멤버를 사용하여 유사하게 정의할 수 있지만, 확장 모듈에서는 대신 Py_TPFLAGS_MANAGED_DICT 및 Py_TPFLAGS_MANAGED_WEAKREF 를 사용할 것을 강력히 권장합니다.

버전 3.12에서 변경: PyMemberDef 은 항상 사용 가능합니다. 이전에는 "structmember.h" 를 포함해야 했습니다.

버전 3.14에서 변경: 이제 "__vectorcalloffset__", "__dic10ffset__" 및 "__weaklistoffset__" 에 대해 Py_RELATIVE_OFFSET 을 사용할 수 있습니다.

PyObject *PyMember_GetOne(const char *obj_addr, struct PyMemberDef *m)¶: …의 일부 안정 ABI.
obj_addr 주소에 있는 객체에 속한 어트리뷰트를 가져옵니다. 해당 어트리뷰트는 PyMemberDef m 으로 설명됩니다. 오류 시 NULL 을 반환합니다.

버전 3.12에서 변경: PyMember_GetOne 은 항상 사용 가능합니다. 이전에는 "structmember.h" 를 포함해야 했습니다.

int PyMember_SetOne(char *obj_addr, struct PyMemberDef *m, PyObject *o)¶: …의 일부 안정 ABI.
obj_addr 주소에 있는 객체의 어트리뷰트를 객체 o 로 설정합니다. 설정할 어트리뷰션은 PyMemberDef m 으로 설명됩니다. 성공하면 0 을, 실패하면 음수를 반환합니다.

버전 3.12에서 변경: PyMember_SetOne 은 항상 사용 가능합니다. 이전에는 "structmember.h" 를 포함해야 했습니다.

멤버 플래그¶

PyMemberDef.flags 와 함께 다음 플래그를 사용할 수 있습니다:

Py_READONLY¶: …의 일부 안정 ABI 버전 3.12 이후로.
쓰기 불가.

Py_AUDIT_READ¶: …의 일부 안정 ABI 버전 3.12 이후로.
읽기 전에 object.__getattr__ 감사 이벤트 를 발생시킵니다.

Py_RELATIVE_OFFSET¶

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

이 PyMemberDef 항목의 offset 이 PyObject 가 아닌 서브클래스 전용 데이터로부터의 오프셋을 나타냄을 의미합니다.

음수의 basicsize 를 사용하여 클래스를 생성할 때만 Py_tp_members slot 의 일부로 사용될 수 있습니다. 이 경우 필수 사항입니다. 클래스 생성 중 슬롯에서 tp_members 를 설정할 때, Python은 해당 플래그를 해제하고 PyMemberDef.offset 을 PyObject 구조체로부터의 오프셋으로 설정합니다.

버전 3.10에서 변경: #include "structmember.h" 에서 사용할 수 있는 RESTRICTED, READ_RESTRICTED, WRITE_RESTRICTED 매크로는 더 이상 사용되지 않습니다(deprecated). READ_RESTRICTED 및 RESTRICTED 는 Py_AUDIT_READ 와 동일하며, WRITE_RESTRICTED 는 아무것도 수행하지 않습니다.

버전 3.12에서 변경: READONLY 매크로가 Py_READONLY 로 이름이 변경되었습니다. PY_AUDIT_READ 매크로는 Py_ 접두사가 붙어 이름이 변경되었습니다. 새로운 이름들은 이제 항상 사용할 수 있습니다. 이전에는 이러한 매크로를 사용하기 위해 #include "structmember.h" 가 필요했습니다. 해당 헤더는 여전히 제공되며 기존 이름을 포함하고 있습니다.

멤버 유형¶

PyMemberDef.type 은 다양한 C 유형에 해당하는 다음 매크로 중 하나가 될 수 있습니다. 파이썬에서 해당 멤버에 접근할 때 동일한 파이썬 타입으로 변환되며, 파이썬에서 설정될 때는 다시 C 타입으로 변환됩니다. 변환이 불가능한 경우 TypeError 또는 ValueError 와 같은 예외가 발생합니다.

(D)로 표시되지 않는 경우, 이러한 방식으로 정의된 어트리뷰션은 예를 들어 del 또는 delattr() 을 사용하여 삭제할 수 없습니다.

매크로 이름	C 형	파이썬 타입
Py_T_BYTE¶ …의 일부 안정 ABI 버전 3.12 이후로.	char	`int`
Py_T_SHORT¶ …의 일부 안정 ABI 버전 3.12 이후로.	short	`int`
Py_T_INT¶ …의 일부 안정 ABI 버전 3.12 이후로.	int	`int`
Py_T_LONG¶ …의 일부 안정 ABI 버전 3.12 이후로.	long	`int`
Py_T_LONGLONG¶ …의 일부 안정 ABI 버전 3.12 이후로.	long long	`int`
Py_T_UBYTE¶ …의 일부 안정 ABI 버전 3.12 이후로.	unsigned char	`int`
Py_T_UINT¶ …의 일부 안정 ABI 버전 3.12 이후로.	unsigned int	`int`
Py_T_USHORT¶ …의 일부 안정 ABI 버전 3.12 이후로.	unsigned short	`int`
Py_T_ULONG¶ …의 일부 안정 ABI 버전 3.12 이후로.	unsigned long	`int`
Py_T_ULONGLONG¶ …의 일부 안정 ABI 버전 3.12 이후로.	unsigned long long	`int`
Py_T_PYSSIZET¶ …의 일부 안정 ABI 버전 3.12 이후로.	Py_ssize_t	`int`
Py_T_FLOAT¶ …의 일부 안정 ABI 버전 3.12 이후로.	float	`float`
Py_T_DOUBLE¶ …의 일부 안정 ABI 버전 3.12 이후로.	double	`float`
Py_T_BOOL¶ …의 일부 안정 ABI 버전 3.12 이후로.	char (0 또는 1로 기록됨)	`bool`
Py_T_STRING¶ …의 일부 안정 ABI 버전 3.12 이후로.	const char* (*)	`str` (RO)
Py_T_STRING_INPLACE¶ …의 일부 안정 ABI 버전 3.12 이후로.	const char[] (*)	`str` (RO)
Py_T_CHAR¶ …의 일부 안정 ABI 버전 3.12 이후로.	char (0-127)	`str` (**)
Py_T_OBJECT_EX¶ …의 일부 안정 ABI 버전 3.12 이후로.	PyObject*	`object` (D)

(*): 널(Null)로 끝나는 UTF8 인코딩 C 문자열. Py_T_STRING`을 사용하면 C 표현이 포인터가 되고, :c:macro:!Py_T_STRING_INPLACE`를 사용하면 문자열이 구조체 내에 직접 저장됩니다.

(**): 길이가 1인 문자열. ASCII만 허용됩니다.

(RO): Py_READONLY 을 의미합니다.

(D): 삭제 가능하며, 이 경우 포인터가 NULL 로 설정됩니다. NULL 포인터를 읽으려고 하면 AttributeError 가 발생합니다.

Added in version 3.12: 이전 버전에서는 매크로가 #include "structmember.h"``를 통해서만 제공되었으며 ``Py_ 접두사가 없는 이름(예: T_INT)으로 명명되었습니다. 해당 헤더는 여전히 사용 가능하며, 다음과 같은 지원 중단된 유형들과 함께 이전의 이름들도 포함하고 있습니다.

T_OBJECT¶: Py_T_OBJECT_EX 와 유사하지만, NULL 이 None 으로 변환됩니다. 이는 파이썬에서 예상치 못한 동작을 초래합니다. 어트리뷰션을 삭제하면 실제로 해당 값이 None 으로 설정되는 것과 같은 효과를 냅니다.

T_NONE¶: 항상 None 입니다. 반드시 Py_READONLY 와 함께 사용해야 합니다.

Getter 및 Setter 정의¶

type PyGetSetDef¶

…의 일부 안정 ABI (모든 멤버 포함).

형에 대한 프로퍼티 같은 액세스를 정의하는 구조체. PyTypeObject.tp_getset 슬롯에 대한 설명도 참조하십시오.

const char *name¶: 어트리뷰트 이름

getter get¶: 어트리뷰트를 얻는 C 함수.

setter set¶: 어트리뷰트를 설정하거나 삭제하는 선택적 C 함수. NULL이면, 어트리뷰트는 읽기 전용입니다.

const char *doc¶: 선택적 독스트링

void *closure¶: 선택적 사용자 데이터 포인터, getter와 setter에 추가 데이터를 제공합니다.

typedef PyObject *(*getter)(PyObject*, void*)¶

…의 일부 안정 ABI.

get 함수는 하나의 PyObject* 매개 변수(인스턴스)와 사용자 데이터 포인터(연관된 closure)를 받아들입니다:

성공하면 새 참조를 반환하고, 실패하면 설정된 예외와 함께 NULL을 반환해야 합니다.

typedef int (*setter)(PyObject*, PyObject*, void*)¶

…의 일부 안정 ABI.

set 함수는 두 개의 PyObject* 매개 변수(인스턴스와 설정할 값)와 사용자 데이터 포인터(연관된 closure)를 받아들입니다:

어트리뷰트를 삭제해야 하는 경우 두 번째 매개 변수는 NULL입니다. 성공하면 0을, 실패하면 설정된 예외와 함께 -1을 반환해야 합니다.

공통 객체 구조체¶

기본 객체 형과 매크로¶

함수와 메서드 구현¶

확장형의 어트리뷰트 액세스¶

멤버 플래그¶

멤버 유형¶

Getter 및 Setter 정의¶

분실물 보관소