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.

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 everythingPyObject_Init() does, and also initializes thelength information for a variable-size object.

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 thetp_basicsize field 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 thetp_itemsize field 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.

voidPyObject_Del(void *op)¶

Releases memory allocated to an object usingPyObject_New() orPyObject_NewVar(). This is normally called from thetp_dealloc handler 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_NoneStruct¶

Object which is visible in Python asNone. This should only be accessedusing thePy_None macro, which evaluates to a pointer to thisobject.