创新互联Python教程：2.自定义扩展类型：教程

2. 自定义扩展类型：教程

python 允许编写 C 扩展模块定义可以从 Python 代码中操纵的新类型，这很像内置的 str 和 list 类型。所有扩展类型的代码都遵循一个模式，但是在您开始之前，您需要了解一些细节。这份文件是对这个主题介绍。

成都创新互联专注为客户提供全方位的互联网综合服务，包含不限于网站制作、成都网站设计、茌平网络推广、微信小程序开发、茌平网络营销、茌平企业策划、茌平品牌公关、搜索引擎seo、人物专访、企业宣传片、企业代运营等，从售前售中售后，我们都将竭诚为您服务，您的肯定，是我们最大的嘉奖；成都创新互联为所有大学生创业者提供茌平建站搭建服务，24小时服务热线：13518219792，官方网址：www.cdcxhl.com

2.1. 基础

The CPython runtime sees all Python objects as variables of type PyObject*, which serves as a “base type” for all Python objects. The PyObject structure itself only contains the object’s reference count and a pointer to the object’s “type object”. This is where the action is; the type object determines which (C) functions get called by the interpreter when, for instance, an attribute gets looked up on an object, a method called, or it is multiplied by another object. These C functions are called “type methods”.

所以，如果你想要定义新的扩展类型，需要创建新的类型对象。

这类事情只能用例子解释，这里用一个最小化但完整的的模块，定义了新的类型叫做 Custom 在C扩展模块 custom 里。

备注

这里展示的方法是定义 static 扩展类型的传统方法。可以适合大部分用途。C API也可以定义在堆上分配的扩展类型，使用 PyType_FromSpec() 函数，但不在本入门里讨论。

 
 
 
 
    
  
  
  
  
  1. #define PY_SSIZE_T_CLEAN
    2. 
  
  
  
  
  2. #include 
    3. 
  
  
  
  
    4. 
  
  
  
  
  4. typedef struct {
    5. 
  
  
  
  
  5.  PyObject_HEAD
    6. 
  
  
  
  
  6.  /* Type-specific fields go here. */
    7. 
  
  
  
  
  7. } CustomObject;
    8. 
  
  
  
  
    9. 
  
  
  
  
  9. static PyTypeObject CustomType = {
    10. 
  
  
  
  
  10.  PyVarObject_HEAD_INIT(NULL, 0)
    11. 
  
  
  
  
  11.  .tp_name = "custom.Custom",
    12. 
  
  
  
  
  12.  .tp_doc = PyDoc_STR("Custom objects"),
    13. 
  
  
  
  
  13.  .tp_basicsize = sizeof(CustomObject),
    14. 
  
  
  
  
  14.  .tp_itemsize = 0,
    15. 
  
  
  
  
  15.  .tp_flags = Py_TPFLAGS_DEFAULT,
    16. 
  
  
  
  
  16.  .tp_new = PyType_GenericNew,
    17. 
  
  
  
  
  17. };
    18. 
  
  
  
  
    19. 
  
  
  
  
  19. static PyModuleDef custommodule = {
    20. 
  
  
  
  
  20.  PyModuleDef_HEAD_INIT,
    21. 
  
  
  
  
  21.  .m_name = "custom",
    22. 
  
  
  
  
  22.  .m_doc = "Example module that creates an extension type.",
    23. 
  
  
  
  
  23.  .m_size = -1,
    24. 
  
  
  
  
  24. };
    25. 
  
  
  
  
    26. 
  
  
  
  
  26. PyMODINIT_FUNC
    27. 
  
  
  
  
  27. PyInit_custom(void)
    28. 
  
  
  
  
  28. {
    29. 
  
  
  
  
  29.  PyObject *m;
    30. 
  
  
  
  
  30.  if (PyType_Ready(&CustomType) < 0)
    31. 
  
  
  
  
  31.  return NULL;
    32. 
  
  
  
  
    33. 
  
  
  
  
  33.  m = PyModule_Create(&custommodule);
    34. 
  
  
  
  
  34.  if (m == NULL)
    35. 
  
  
  
  
  35.  return NULL;
    36. 
  
  
  
  
    37. 
  
  
  
  
  37.  Py_INCREF(&CustomType);
    38. 
  
  
  
  
  38.  if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType) < 0) {
    39. 
  
  
  
  
  39.  Py_DECREF(&CustomType);
    40. 
  
  
  
  
  40.  Py_DECREF(m);
    41. 
  
  
  
  
  41.  return NULL;
    42. 
  
  
  
  
  42.  }
    43. 
  
  
  
  
    44. 
  
  
  
  
  44.  return m;
    45. 
  
  
  
  
  45. }
    46.

这部分很容易理解，这是为了跟上一章能对接上。这个文件定义了三件事：

  1. Custom 类的对象 object 包含了： CustomObject 结构，这会为每个 Custom 实例分配一次。

  2. Custom type 的行为：这是 CustomType 结构体，其定义了一堆标识和函数指针，会指向解释器里请求的操作。

  3. 初始化 custom 模块： PyInit_custom 函数和对应的 custommodule 结构体。

结构的第一块是

 
 
 
 
    
  
  
  
  
  1. typedef struct {
    2. 
  
  
  
  
  2.  PyObject_HEAD
    3. 
  
  
  
  
  3. } CustomObject;
    4.

This is what a Custom object will contain. PyObject_HEAD is mandatory at the start of each object struct and defines a field called ob_base of type PyObject, containing a pointer to a type object and a reference count (these can be accessed using the macros Py_TYPE and Py_REFCNT respectively). The reason for the macro is to abstract away the layout and to enable additional fields in debug builds.

备注

注意在宏 PyObject_HEAD 后没有分号。意外添加分号会导致编译器提示出错。

当然，对象除了在 PyObject_HEAD 存储数据外，还有额外数据；例如，如下定义了标准的Python浮点数:

 
 
 
 
    
  
  
  
  
  1. typedef struct {
    2. 
  
  
  
  
  2.  PyObject_HEAD
    3. 
  
  
  
  
  3.  double ob_fval;
    4. 
  
  
  
  
  4. } PyFloatObject;
    5.

第二个位是类型对象的定义:

 
 
 
 
    
  
  
  
  
  1. static PyTypeObject CustomType = {
    2. 
  
  
  
  
  2.  PyVarObject_HEAD_INIT(NULL, 0)
    3. 
  
  
  
  
  3.  .tp_name = "custom.Custom",
    4. 
  
  
  
  
  4.  .tp_doc = PyDoc_STR("Custom objects"),
    5. 
  
  
  
  
  5.  .tp_basicsize = sizeof(CustomObject),
    6. 
  
  
  
  
  6.  .tp_itemsize = 0,
    7. 
  
  
  
  
  7.  .tp_flags = Py_TPFLAGS_DEFAULT,
    8. 
  
  
  
  
  8.  .tp_new = PyType_GenericNew,
    9. 
  
  
  
  
  9. };
    10.

备注

推荐使用如上C99风格的初始化，以避免列出所有的 PyTypeObject 字段，其中很多是你不需要关心的，这样也可以避免关注字段的定义顺序。

在 object.h 中实际定义的 PyTypeObject 具有比如上定义更多的 字段。 剩余的字段会由 C 编译器用零来填充，通常的做法是不显式地指定它们，除非你确实需要它们。

我们先挑选一部分，每次一个字段:

 
 
 
 
    
  
  
  
  
  1. PyVarObject_HEAD_INIT(NULL, 0)
    2.

这一行是强制的样板，用以初始化如上提到的 ob_base 字段:

 
 
 
 
    
  
  
  
  
  1. .tp_name = "custom.Custom",
    2.

我们的类型的名称。 这将出现在我们的对象的默认文本表示形式和某些错误消息中，例如:

 
 
 
 
    
  
  
  
  
  1. >>> "" + custom.Custom()
    2. 
  
  
  
  
  2. Traceback (most recent call last):
    3. 
  
  
  
  
  3.  File "", line 1, in 
    4. 
  
  
  
  
  4. TypeError: can only concatenate str (not "custom.Custom") to str
    5.

Note that the name is a dotted name that includes both the module name and the name of the type within the module. The module in this case is custom and the type is Custom, so we set the type name to custom.Custom. Using the real dotted import path is important to make your type compatible with the pydoc and pickle modules.

 
 
 
 
    
  
  
  
  
  1. .tp_basicsize = sizeof(CustomObject),
    2. 
  
  
  
  
  2. .tp_itemsize = 0,
    3.

This is so that Python knows how much memory to allocate when creating new Custom instances. tp_itemsize is only used for variable-sized objects and should otherwise be zero.

备注

If you want your type to be subclassable from Python, and your type has the same tp_basicsize as its base type, you may have problems with multiple inheritance. A Python subclass of your type will have to list your type first in its __bases__, or else it will not be able to call your type’s __new__() method without getting an error. You can avoid this problem by ensuring that your type has a larger value for tp_basicsize than its base type does. Most of the time, this will be true anyway, because either your base type will be object, or else you will be adding data members to your base type, and therefore increasing its size.

我们将类旗标设为 Py_TPFLAGS_DEFAULT。

 
 
 
 
    
  
  
  
  
  1. .tp_flags = Py_TPFLAGS_DEFAULT,
    2.

All types should include this constant in their flags. It enables all of the members defined until at least Python 3.3. If you need further members, you will need to OR the corresponding flags.

We provide a doc string for the type in tp_doc.

 
 
 
 
    
  
  
  
  
  1. .tp_doc = PyDoc_STR("Custom objects"),
    2.

To enable object creation, we have to provide a tp_new handler. This is the equivalent of the Python method __new__(), but has to be specified explicitly. In this case, we can just use the default implementation provided by the API function PyType_GenericNew().

 
 
 
 
    
  
  
  
  
  1. .tp_new = PyType_GenericNew,
    2.

Everything else in the file should be familiar, except for some code in PyInit_custom():

 
 
 
 
    
  
  
  
  
  1. if (PyType_Ready(&CustomType) < 0)
    2. 
  
  
  
  
  2.  return;
    3.

This initializes the Custom type, filling in a number of members to the appropriate default values, including ob_type that we initially set to NULL.

 
 
 
 
    
  
  
  
  
  1. Py_INCREF(&CustomType);
    2. 
  
  
  
  
  2. if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType) < 0) {
    3. 
  
  
  
  
  3.  Py_DECREF(&CustomType);
    4. 
  
  
  
  
  4.  Py_DECREF(m);
    5. 
  
  
  
  
  5.  return NULL;
    6. 
  
  
  
  
  6. }
    7.

This adds the type to the module dictionary. This allows us to create Custom instances by calling the Custom class:

 
 
 
 
    
  
  
  
  
  1. >>> import custom
    2. 
  
  
  
  
  2. >>> mycustom = custom.Custom()
    3.

That’s it! All that remains is to build it; put the above code in a file called custom.c and:

 
 
 
 
    
  
  
  
  
  1. from distutils.core import setup, Extension
    2. 
  
  
  
  
  2. setup(name="custom", version="1.0",
    3. 
  
  
  
  
  3.  ext_modules=[Extension("custom", ["custom.c"])])
    4.

in a file called setup.py; then typing

 
 
 
 
    
  
  
  
  
  1. $ python setup.py build
    2.

at a shell should produce a file custom.so in a subdirectory; move to that directory and fire up Python —- you should be able to import custom and play around with Custom objects.

这并不难，对吗？

Of course, the current Custom type is pretty uninteresting. It has no data and doesn’t do anything. It can’t even be subclassed.

备注

While this documentation showcases the standard distutils module for building C extensions, it is recommended in real-world use cases to use the newer and better-maintained setuptools library. Documentation on how to do this is out of scope for this document and can be found in the Python Packaging User’s Guide.

2.2. Adding data and methods to the Basic example

Let’s extend the basic example to add some data and methods. Let’s also make the type usable as a base class. We’ll create a new module, custom2 that adds these capabilities:

 
 
 
 
    
  
  
  
  
  1. #define PY_SSIZE_T_CLEAN
    2. 
  
  
  
  
  2. #include 
    3. 
  
  
  
  
  3. #include "structmember.h"
    4. 
  
  
  
  
    5. 
  
  
  
  
  5. typedef struct {
    6. 
  
  
  
  
  6.  PyObject_HEAD
    7. 
  
  
  
  
  7.  PyObject *first; /* first name */
    8. 
  
  
  
  
  8.  PyObject *last; /* last name */
    9. 
  
  
  
  
  9.  int number;
    10. 
  
  
  
  
  10. } CustomObject;
    11. 
  
  
  
  
    12. 
  
  
  
  
  12. static void
    13. 
  
  
  
  
  13. Custom_dealloc(CustomObject *self)
    14. 
  
  
  
  
  14. {
    15. 
  
  
  
  
  15.  Py_XDECREF(self->first);
    16. 
  
  
  
  
  16.  Py_XDECREF(self->last);
    17. 
  
  
  
  
  17.  Py_TYPE(self)->tp_free((PyObject *) self);
    18. 
  
  
  
  
  18. }
    19. 
  
  
  
  
    20. 
  
  
  
  
  20. static PyObject *
    21. 
  
  
  
  
  21. Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
    22. 
  
  
  
  
  22. {
    23. 
  
  
  
  
  23.  CustomObject *self;
    24. 
  
  
  
  
  24.  self = (CustomObject *) type->tp_alloc(type, 0);
    25. 
  
  
  
  
  25.  if (self != NULL) {
    26. 
  
  
  
  
  26.  self->first = PyUnicode_FromString("");
    27. 
  
  
  
  
  27.  if (self->first == NULL) {
    28. 
  
  
  
  
  28.  Py_DECREF(self);
    29. 
  
  
  
  
  29.  return NULL;
    30. 
  
  
  
  
  30.  }
    31. 
  
  
  
  
  31.  self->last = PyUnicode_FromString("");
    32. 
  
  
  
  
  32.  if (self->last == NULL) {
    33. 
  
  
  
  
  33.  Py_DECREF(self);
    34. 
  
  
  
  
  34.  return NULL;
    35. 
  
  
  
  
  35.  }
    36. 
  
  
  
  
  36.  self->number = 0;
    37. 
  
  
  
  
  37.  }
    38. 
  
  
  
  
  38.  return (PyObject *) self;
    39. 
  
  
  
  
  39. }
    40. 
  
  
  
  
    41. 
  
  
  
  
  41. static int
    42. 
  
  
  
  
  42. Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
    43. 
  
  
  
  
  43. {
    44. 
  
  
  
  
  44.  static char *kwlist[] = {"first", "last", "number", NULL};
    45. 
  
  
  
  
  45.  PyObject *first = NULL, *last = NULL, *tmp;
    46. 
  
  
  
  
    47. 
  
  
  
  
  47.  if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOi", kwlist,
    48. 
  
  
  
  
  48.  &first, &last,
    49. 
  
  
  
  
  49.  &self->number))
    50. 
  
  
  
  
  50.  return -1;
    51. 
  
  
  
  
    52. 
  
  
  
  
  52.  if (first) {
    53. 
  
  
  
  
  53.  tmp = self->first;
    54. 
  
  
  
  
  54.  Py_INCREF(first);
    55. 
  
  
  
  
  55.  self->first = first;
    56. 
  
  
  
  
  56.  Py_XDECREF(tmp);
    57. 
  
  
  
  
  57.  }
    58. 
  
  
  
  
  58.  if (last) {
    59. 
  
  
  
  
  59.  tmp = self->last;
    60. 
  
  
  
  
  60.  Py_INCREF(last);
    61. 
  
  
  
  
  61.  self->last = last;
    62. 
  
  
  
  
  62.  Py_XDECREF(tmp);
    63. 
  
  
  
  
  63.  }
    64. 
  
  
  
  
  64.  return 0;
    65. 
  
  
  
  
  65. }
    66. 
  
  
  
  
    67. 
  
  
  
  
  67. static PyMemberDef Custom_members[] = {
    68. 
  
  
  
  
  68.  {"first", T_OBJECT_EX, offsetof(CustomObject, first), 0,
    69. 
  
  
  
  
  69.  "first name"},
    70. 
  
  
  
  
  70.  {"last", T_OBJECT_EX, offsetof(CustomObject, last), 0,
    71. 
  
  
  
  
  71.  "last name"},
    72. 
  
  
  
  
  72.  {"number", T_INT, offsetof(CustomObject, number), 0,
    73. 
  
  
  
  
  73.  "custom number"},
    74. 
  
  
  
  
  74.  {NULL} /* Sentinel */
    75. 
  
  
  
  
  75. };
    76. 
  
  
  
  
    77. 
  
  
  
  
  77. static PyObject *
    78. 
  
  
  
  
  78. Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored))
    79. 
  
  
  
  
  79. {
    80. 
  
  
  
  
  80.  if (self->first == NULL) {
    81. 
  
  
  
  
  81.  PyErr_SetString(PyExc_AttributeError, "first");
    82. 
  
  
  
  
  82.  return NULL;
    83. 
  
  
  
  
  83.  }
    84. 
  
  
  
  
  84.  if (self->last == NULL) {
    85. 
  
  
  
  
  85.  PyErr_SetString(PyExc_AttributeError, "last");
    86. 
  
  
  
  
  86.  return NULL;
    87. 
  
  
  
  
  87.  }
    88. 
  
  
  
  
  88.  return PyUnicode_FromFormat("%S %S", self->first, self->last);
    89. 
  
  
  
  
  89. }
    90. 
  
  
  
  
    91. 
  
  
  
  
  91. static PyMethodDef Custom_methods[] = {
    92. 
  
  
  
  
  92.  {"name", (PyCFunction) Custom_name, METH_NOARGS,
    93. 
  
  
  
  
  93.  "Return the name, combining the first and last name"
    94. 
  
  
  
  
  94.  },
    95. 
  
  
  
  
  95.  {NULL} /* Sentinel */
    96. 
  
  
  
  
  96. };
    97. 
  
  
  
  
    98. 
  
  
  
  
  98. static PyTypeObject CustomType = {
    99. 
  
  
  
  
  99.  PyVarObject_HEAD_INIT(NULL, 0)
    100. 
  
  
  
  
  100.  .tp_name = "custom2.Custom",
    101. 
  
  
  
  
  101.  .tp_doc = PyDoc_STR("Custom objects"),
    102. 
  
  
  
  
  102.  .tp_basicsize = sizeof(CustomObject),
    103. 
  
  
  
  
  103.  .tp_itemsize = 0,
    104. 
  
  
  
  
  104.  .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
    105. 
  
  
  
  
  105.  .tp_new = Custom_new,
    106. 
  
  
  
  
  106.  .tp_init = (initproc) Custom_init,
    107. 
  
  
  
  
  107.  .tp_dealloc = (destructor) Custom_dealloc,
    108. 
  
  
  
  
  108.  .tp_members = Custom_members,
    109. 
  
  
  
  
  109.  .tp_methods = Custom_methods,
    110. 
  
  
  
  
  110. };
    111. 
  
  
  
  
    112. 
  
  
  
  
  112. static PyModuleDef custommodule = {
    113. 
  
  
  
  
  113.  PyModuleDef_HEAD_INIT,
    114. 
  
  
  
  
  114.  .m_name = "custom2",
    115. 
  
  
  
  
  115.  .m_doc = "Example module that creates an extension type.",
    116. 
  
  
  
  
  116.  .m_size = -1,
    117. 
  
  
  
  
  117. };
    118. 
  
  
  
  
    119. 
  
  
  
  
  119. PyMODINIT_FUNC
    120. 
  
  
  
  
  120. PyInit_custom2(void)
    121. 
  
  
  
  
  121. {
    122. 
  
  
  
  
  122.  PyObject *m;
    123. 
  
  
  
  
  123.  if (PyType_Ready(&CustomType) < 0)
    124. 
  
  
  
  
  124.  return NULL;
    125. 
  
  
  
  
    126. 
  
  
  
  
  126.  m = PyModule_Create(&custommodule);
    127. 
  
  
  
  
  127.  if (m == NULL)
    128. 
  
  
  
  
  128.  return NULL;
    129. 
  
  
  
  
    130. 
  
  
  
  
  130.  Py_INCREF(&CustomType);
    131. 
  
  
  
  
  131.  if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType) < 0) {
    132. 
  
  
  
  
  132.  Py_DECREF(&CustomType);
    133. 
  
  
  
  
  133.  Py_DECREF(m);
    134. 
  
  
  
  
  134.  return NULL;
    135. 
  
  
  
  
  135.  }
    136. 
  
  
  
  
    137. 
  
  
  
  
  137.  return m;
    138. 
  
  
  
  
  138. }
    139.

This version of the module has a number of changes.

We’ve added an extra include:

 
 
 
 
    
  
  
  
  
  1. #include 
    2.

This include provides declarations that we use to handle attributes, as described a bit later.

The Custom type now has three data attributes in its C struct, first, last, and number. The first and last variables are Python strings containing first and last names. The number attribute is a C integer.

The object structure is updated accordingly:

 
 
 
 
    
  
  
  
  
  1. typedef struct {
    2. 
  
  
  
  
  2.  PyObject_HEAD
    3. 
  
  
  
  
  3.  PyObject *first; /* first name */
    4. 
  
  
  
  
  4.  PyObject *last; /* last name */
    5. 
  
  
  
  
  5.  int number;
    6. 
  
  
  
  
  6. } CustomObject;
    7.

Because we now have data to manage, we have to be more careful about object allocation and deallocation. At a minimum, we need a deallocation method:

 
 
 
 
    
  
  
  
  
  1. static void
    2. 
  
  
  
  
  2. Custom_dealloc(CustomObject *self)
    3. 
  
  
  
  
  3. {
    4. 
  
  
  
  
  4.  Py_XDECREF(self->first);
    5. 
  
  
  
  
  5.  Py_XDECREF(self->last);
    6. 
  
  
  
  
  6.  Py_TYPE(self)->tp_free((PyObject *) self);
    7. 
  
  
  
  
  7. }
    8.

which is assigned to the tp_dealloc member:

 
 
 
 
    
  
  
  
  
  1. .tp_dealloc = (destructor) Custom_dealloc,
    2.

This method first clears the reference counts of the two Python attributes. Py_XDECREF() correctly handles the case where its argument is NULL (which might happen here if tp_new failed midway). It then calls the tp_free member of the object’s type (computed by Py_TYPE(self)) to free the object’s memory. Note that the object’s type might not be CustomType, because the object may be an instance of a subclass.

备注

The explicit cast to destructor above is needed because we defined Custom_dealloc to take a CustomObject * argument, but the tp_dealloc function pointer expects to receive a PyObject * argument. Otherwise, the compiler will emit a warning. This is object-oriented polymorphism, in C!

We want to make sure that the first and last names are initialized to empty strings, so we provide a tp_new implementation:

 
 
 
 
    
  
  
  
  
  1. static PyObject *
    2. 
  
  
  
  
  2. Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
    3. 
  
  
  
  
  3. {
    4. 
  
  
  
  
  4.  CustomObject *self;
    5. 
  
  
  
  
  5.  self = (CustomObject *) type->tp_alloc(type, 0);
    6. 
  
  
  
  
  6.  if (self != NULL) {
    7. 
  
  
  
  
  7.  self->first = PyUnicode_FromString("");
    8. 
  
  
  
  
  8.  if (self->first == NULL) {
    9. 
  
  
  
  
  9.  Py_DECREF(self);
    10. 
  
  
  
  
  10.  return NULL;
    11. 
  
  
  
  
  11.  }
    12. 
  
  
  
  
  12.  self->last = PyUnicode_FromString("");
    13. 
  
  
  
  
  13.  if (self->last == NULL) {
    14. 
  
  
  
  
  14.  Py_DECREF(self);
    15. 
  
  
  
  
  15.  return NULL;
    16. 
  
  
  
  
  16.  }
    17. 
  
  
  
  
  17.  self->number = 0;
    18. 
  
  
  
  
  18.  }
    19. 
  
  
  
  
  19.  return (PyObject *) self;
    20. 
  
  
  
  
  20. }
    21.

and install it in the tp_new member:

 
 
 
 
    
  
  
  
  
  1. .tp_new = Custom_new,
    2.

The tp_new handler is responsible for creating (as opposed to initializing) objects of the type. It is exposed in Python as the __new__() method. It is not required to define a tp_new member, and indeed many extension types will simply reuse PyType_GenericNew() as done in the first version of the Custom type above. In this case, we use the tp_new handler to initialize the first and last attributes to non-NULL default values.

tp_new is passed the type being instantiated (not necessarily CustomType, if a subclass is instantiated) and any arguments passed when the type was called, and is expected to return the instance created. tp_new handlers always accept positional and keyword arguments, but they often ignore the arguments, leaving the argument handling to initializer (a.k.a. tp_init in C or __init__ in Python) methods.

备注

tp_new shouldn’t call tp_init explicitly, as the interpreter will do it itself.

The tp_new implementation calls the tp_alloc slot to allocate memory:

 
 
 
 
    
  
  
  
  
  1. self = (CustomObject *) type->tp_alloc(type, 0);
    2.

Since memory allocation may fail, we must check the tp_alloc result against NULL before proceeding.

备注

We didn’t fill the tp_alloc slot ourselves. Rather PyType_Ready() fills it for us by inheriting it from our base class, which is object by default. Most types use the default allocation strategy.

备注

If you are creating a co-operative tp_new (one that calls a base type’s tp_new or __new__()), you must not try to determine what method to call using method resolution order at runtime. Always statically determine what type you are going to call, and call its tp_new directly, or via type->tp_base->tp_new. If you do not do this, Python subclasses of your type that also inherit from other Python-defined classes may not work correctly. (Specifically, you may not be able to create instances of such subclasses without getting a TypeError.)

We also define an initialization function which accepts arguments to provide initial values for our instance:

 
 
 
 
    
  
  
  
  
  1. static int
    2. 
  
  
  
  
  2. Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
    3. 
  
  
  
  
  3. {
    4. 
  
  
  
  
  4.  static char *kwlist[] = {"first", "last", "number", NULL};
    5. 
  
  
  
  
  5.  PyObject *first = NULL, *last = NULL, *tmp;
    6. 
  
  
  
  
    7. 
  
  
  
  
  7.  if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOi", kwlist,
    8. 
  
  
  
  
  8.  &first, &last,
    9. 
  
  
  
  
  9.  &self->number))
    10. 
  
  
  
  
  10.  return -1;
    11. 
  
  
  
  
    12. 
  
  
  
  
  12.  if (first) {
    13. 
  
  
  
  
  13.  tmp = self->first;
    14. 
  
  
  
  
  14.  Py_INCREF(first);
    15. 
  
  
  
  
  15.  self->first = first;
    16. 
  
  
  
  
  16.  Py_XDECREF(tmp);
    17. 
  
  
  
  
  17.  }
    18. 
  
  
  
  
  18.  if (last) {
    19. 
  
  
  
  
  19.  tmp = self->last;
    20. 
  
  
  
  
  20.  Py_INCREF(last);
    21. 
  
  
  
  
  21.  self->last = last;
    22. 
  
  
  
  
  22.  Py_XDECREF(tmp);
    23. 
  
  
  
  
  23.  }
    24. 
  
  
  
  
  24.  return 0;
    25. 
  
  
  
  
  25. }
    26.

by filling the tp_init slot.

 
 
 
 
    
  
  
  
  
  1. .tp_init = (initproc) Custom_init,
    2.

The tp_init slot is exposed in Python as the __init__() method. It is used to initialize an object after it’s created. Initializers always accept positional and keyword arguments, and they should return either 0 on success or -1 on error.

Unlike the tp_new handler, there is no guarantee that tp_init is called at all (for example, the pickle module by default doesn’t call __init__() on unpickled instances). It can also be called multiple times. Anyone can call the __init__() method on our objects. For this reason, we have to be extra careful when assigning the new attribute values. We might be tempted, for example to assign the first member like this:

 
 
 
 
    
  
  
  
  
  1. if (first) {
    2. 
  
  
  
  
  2.  Py_XDECREF(self->first);
    3. 
  
  
  
  
  3.  Py_INCREF(first);
    4. 
  
  
  
  
  4.  self->first = first;
    5. 
  
  
  
  
  5. }
    6.

But this would be risky. Our type doesn’t restrict the type of the first member, so it could be any kind of object. It could have a destructor that causes code to be executed that tries to access the first member; or that destructor could release the Global interpreter Lock and let arbitrary code run in other threads that accesses and modifies our object.

To be paranoid and protect ourselves against this possibility, we almost always reassign members before decrementing their reference counts. When don’t we have to do this?

  • when we absolutely know that the reference count is greater than 1;

  • when we know that deallocation of the object 1 will neither release the GIL nor cause any calls back into our type’s code;

  • when decrementing a reference count in a tp_dealloc handler on a type which doesn’t support cyclic garbage collection 2.

We want to expose our instance variables as attributes. There are a number of ways to do that. The simplest way is to define member definitions:

 
 
 
 
    
  
  
  
  
  1. static PyMemberDef Custom_members[] = {
    2. 
  
  
  
  
  2.  {"first", T_OBJECT_EX, offsetof(CustomObject, first), 0,
    3. 
  
  
  
  
  3.  "first name"},
    4. 
  
  
  
  
  4.  {"last", T_OBJECT_EX, offsetof(CustomObject, last), 0,
    5. 
  
  
  
  
  5.  "last name"},
    6. 
  
  
  
  
  6.  {"number", T_INT, offsetof(CustomObject, number), 0,
    7. 
  
  
  
  
  7.  "custom number"},
    8. 
  
  
  
  
  8.  {NULL} /* Sentinel */
    9. 
  
  
  
  
  9. };
    10.

and put the definitions in the tp_members slot:

 
 
 
 
    
  
  
  
  
  1. .tp_members = Custom_members,
    2.

Each member definition has a member name, type, offset, access flags and documentation string. See the 泛型属性管理 section below for details.

A disadvantage of this approach is that it doesn’t provide a way to restrict the types of objects that can be assigned to the Python attributes. We expect the first and last names to be strings, but any Python objects can be assigned. Further, the attributes can be deleted, setting the C pointers to NULL. Even though we can make sure the members are initialized to non-NULL values, the members can be set to NULL if the attributes are deleted.

We define a single method, Custom.name(), that outputs the objects name as the concatenation of the first and last names.

 
 
 
 
    
  
  
  
  
  1. static PyObject *
    2. 
  
  
  
  
  2. Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored))
    3. 
  
  
  
  
  3. {
    4. 
  
  
  
  
  4.  if (self->first == NULL) {
    5. 
  
  
  
  
  5.  PyErr_SetString(PyExc_AttributeError, "first");
    6. 
  
  
  
  
  6.  return NULL;
    7. 
  
  
  
  
  7.  }
    8. 
  
  
  
  
  8.  if (self->last == NULL) {
    9. 
  
  
  
  
  9.  PyErr_SetString(PyExc_AttributeError, "last");
    10. 
  
  
  
  
  10.  return NULL;
    11. 
  
  
  
  
  11.  }
    12. 
  
  
  
  
  12.  return PyUnicode_FromFormat("%S %S", self->first, self->last);
    13. 
  
  
  
  
  13. }
    14.

The method is implemented as a C function that takes a Custom (or Custom subclass) instance as the first argument. Methods always take an instance as the first argument. Methods often take positional and keyword arguments as well, but in this case we don’t take any and don’t need to accept a positional argument tuple or keyword argument dictionary. This method is equivalent to the Python method:

 
 
 
 
    
  
  
  
  
  1. def name(self):
    2. 
  
  
  
  
  2.  return "%s %s" % (self.first, self.last)
    3.

Note that we have to check for the possibility that our first and last members are NULL. This is because they can be deleted, in which case they are set to NULL. It would be better to prevent deletion of these attributes and to restrict the attribute values to be strings. We’ll see how to do that in the next section.

Now that we’ve defined the method, we need to create an array of method definitions:

 
 
 
 
    
  
  
  
  
  1. static PyMethodDef Custom_methods[] = {
    2. 
  
  
  
  
  2.  {"name", (PyCFunction) Custom_name, METH_NOARGS,
    3. 
  
  
  
  
  3.  "Return the name, combining the first and last name"
    4. 
  
  
  
  
  4.  },
    5. 
  
  
  
  
  5.  {NULL} /* Sentinel */
    6. 
  
  
  
  
  6. };
    7.

(note that we used the METH_NOARGS flag to indicate that the method is expecting no arguments other than self)

and assign it to the tp_methods slot:

 
 
 
 
    
  
  
  
  
  1. .tp_methods = Custom_methods,
    2.

Finally, we’ll make our type usable as a base class for subclassing. We’ve written our methods carefully so far so that they don’t make any assumptions about the type of the object being created or used, so all we need to do is to add the Py_TPFLAGS_BASETYPE to our class flag definition:

 
 
 
 
    
  
  
  
  
  1. .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
    2.

We rename PyInit_custom() to PyInit_custom2(), update the module name in the PyModuleDef struct, and update the full class name in the PyTypeObject struct.

Finally, we update our setup.py file to build the new module:

 
 
 
 
    
  
  
  
  
  1. from distutils.core import setup, Extension
    2. 
  
  
  
  
  2. setup(name="custom", version="1.0",
    3. 
  
  
  
  
  3.  ext_modules=[
    4. 
  
  
  
  
  4.  Extension("custom", ["custom.c"]),
    5. 
  
  
  
  
  5.  Extension("custom2", ["custom2.c"]),
    6. 
  
  
  
  
  6.  ])
    7.

2.3. Providing finer control over data attributes

In this section, we’ll provide finer control over how the first and last attributes are set in the Custom example. In the previous version of our module, the instance variables first and last could be set to non-string values or even deleted. We want to make sure that these attributes always contain strings.

 
 
 
 
    
  
  
  
  
  1. #define PY_SSIZE_T_CLEAN
    2. 
  
  
  
  
  2. #include 
    3. 
  
  
  
  
  3. #include "structmember.h"
    4. 
  
  
  
  
    5. 
  
  
  
  
  5. typedef struct {
    6. 
  
  
  
  
  6.  PyObject_HEAD
    7. 
  
  
  
  
  7.  PyObject *first; /* first name */
    8. 
  
  
  
  
  8.  PyObject *last; /* last name */
    9. 
  
  
  
  
  9.  int number;
    10. 
  
  
  
  
  10. } CustomObject;
    11. 
  
  
  
  
    12. 
  
  
  
  
  12. static void
    13. 
  
  
  
  
  13. Custom_dealloc(CustomObject *self)
    14. 
  
  
  
  
  14. {
    15. 
  
  
  
  
  15.  Py_XDECREF(self->first);
    16. 
  
  
  
  
  16.  Py_XDECREF(self->last);
    17. 
  
  
  
  
  17.  Py_TYPE(self)->tp_free((PyObject *) self);
    18. 
  
  
  
  
  18. }
    19. 
  
  
  
  
    20. 
  
  
  
  
  20. static PyObject *
    21. 
  
  
  
  
  21. Custom_new(PyTypeObject *type, PyObject *args, 
                当前名称：创新互联Python教程：2.自定义扩展类型：教程
                
    
                文章路径：http://www.mswzjz.com/qtweb/news46/195796.html
            
    
            
    
                网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等
                                
    
            
    
                广告
                
            
    
            
    
                声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源：
                创新互联

猜你还喜欢下面的内容

定制开发知识

同城分类信息

西部信息中心　　 　网站建设公司　　 　成都网站建设公司　　 　优化排名　　 　成都400电话办理　　 　网站建设公司　　 　彭州做网站　　 　大橙子网站建设　　 　成都网站设计　　 　广安园林景观设计　　 　广汉锦华　　 　网站域名　　 　眉山网站建设　　 　微信小程序公众号开发　　 　成都移动主机托管　　 　温江网站设计　　 　重庆移动网站建设　　 　小谭建站　　 　成都网站建设　　 　成都店面装修公司