Allocating Objects on the Heap¶
- PyObject*
_PyObject_New(PyTypeObject *type)¶ - Return value: New reference.
- PyVarObject*
_PyObject_NewVar(PyTypeObject *type, Py_ssize_t size)¶ - Return value: New reference.
Changed in version 2.5:This function used an
inttype forsize. This might requirechanges in your code for properly supporting 64-bit systems.
- PyObject*
PyObject_Init(PyObject *op,PyTypeObject *type)¶ - Return value: Borrowed reference.
Initialize a newly-allocated objectop with its type and initialreference. Returns the initialized object. Iftype indicates that theobject participates in the cyclic garbage detector, it is added to thedetector’s set of observed objects. Other fields of the object are notaffected.
- PyVarObject*
PyObject_InitVar(PyVarObject *op,PyTypeObject *type, Py_ssize_t size)¶ - Return value: Borrowed reference.
This does everything
PyObject_Init()does, and also initializes thelength information for a variable-size object.Changed in version 2.5:This function used an
inttype forsize. This might requirechanges in your code for properly supporting 64-bit systems.
- TYPE*
PyObject_New(TYPE,PyTypeObject *type)¶ - Return value: New reference.
Allocate a new Python object using the C structure typeTYPE and thePython type objecttype. Fields not defined by the Python object headerare not initialized; the object’s reference count will be one. The size ofthe memory allocation is determined from the
tp_basicsizefield ofthe type object.
- TYPE*
PyObject_NewVar(TYPE,PyTypeObject *type, Py_ssize_t size)¶ - Return value: New reference.
Allocate a new Python object using the C structure typeTYPE and thePython type objecttype. Fields not defined by the Python object headerare not initialized. The allocated memory allows for theTYPE structureplussize fields of the size given by the
tp_itemsizefield oftype. This is useful for implementing objects like tuples, which areable to determine their size at construction time. Embedding the array offields into the same allocation decreases the number of allocations,improving the memory management efficiency.Changed in version 2.5:This function used an
inttype forsize. This might requirechanges in your code for properly supporting 64-bit systems.
- void
PyObject_Del(PyObject *op)¶ Releases memory allocated to an object using
PyObject_New()orPyObject_NewVar(). This is normally called from thetp_deallochandler specified in the object’s type. The fields ofthe object should not be accessed after this call as the memory is nolonger a valid Python object.
- PyObject*
Py_InitModule(char *name,PyMethodDef *methods)¶ - Return value: Borrowed reference.
Create a new module object based on a name and table of functions,returning the new module object.
Changed in version 2.3:Older versions of Python did not supportNULL as the value for themethods argument.
- PyObject*
Py_InitModule3(char *name,PyMethodDef *methods, char *doc)¶ - Return value: Borrowed reference.
Create a new module object based on a name and table of functions,returning the new module object. Ifdoc is non-NULL, it will be usedto define the docstring for the module.
Changed in version 2.3:Older versions of Python did not supportNULL as the value for themethods argument.
- PyObject*
Py_InitModule4(char *name,PyMethodDef *methods, char *doc,PyObject *self, int apiver)¶ - Return value: Borrowed reference.
Create a new module object based on a name and table of functions,returning the new module object. Ifdoc is non-NULL, it will be usedto define the docstring for the module. Ifself is non-NULL, it willbe passed to the functions of the module as their (otherwiseNULL) firstparameter. (This was added as an experimental feature, and there are noknown uses in the current version of Python.) Forapiver, the only valuewhich should be passed is defined by the constant
PYTHON_API_VERSION.Note
Most uses of this function should probably be using the
Py_InitModule3()instead; only use this if you are sure you needit.Changed in version 2.3:Older versions of Python did not supportNULL as the value for themethods argument.