Allocating objects on the heap

Initialize a newly allocated object op with its type and initial reference. Returns the initialized object. Other fields of the object are not initialized. Despite its name, this function is unrelated to the object's ~object.__init__ method (~PyTypeObject.tp_init slot). Specifically, this function does not call the object's !__init__ method.

In general, consider this function to be a low-level routine. Use ~PyTypeObject.tp_alloc where possible. For implementing !tp_alloc for your type, prefer PyType_GenericAlloc or PyObject_New.

[!NOTE] This function only initializes the object's memory corresponding to the initial PyObject structure. It does not zero the rest.

This does everything PyObject_Init does, and also initializes the length information for a variable-size object.

[!NOTE] This function only initializes some of the object's memory. It does not zero the rest.

Allocates a new Python object using the C structure type TYPE and the Python type object typeobj (PyTypeObject*) by calling PyObject_Malloc to allocate memory and initializing it like PyObject_Init. The caller will own the only reference to the object (i.e. its reference count will be one).

Avoid calling this directly to allocate memory for an object; call the type's ~PyTypeObject.tp_alloc slot instead.

When populating a type's ~PyTypeObject.tp_alloc slot, PyType_GenericAlloc is preferred over a custom function that simply calls this macro.

This macro does not call ~PyTypeObject.tp_alloc, ~PyTypeObject.tp_new (~object.__new__), or ~PyTypeObject.tp_init (~object.__init__).

This cannot be used for objects with Py_TPFLAGS_HAVE_GC set in ~PyTypeObject.tp_flags; use PyObject_GC_New instead.

Memory allocated by this macro must be freed with PyObject_Free (usually called via the object's ~PyTypeObject.tp_free slot).

[!NOTE] The returned memory is not guaranteed to have been completely zeroed before it was initialized.

[!NOTE] This macro does not construct a fully initialized object of the given type; it merely allocates memory and prepares it for further initialization by ~PyTypeObject.tp_init. To construct a fully initialized object, call typeobj instead. For example:

PyObject *foo = PyObject_CallNoArgs((PyObject *)&PyFoo_Type);

• PyObject_Free
• PyObject_GC_New
• PyType_GenericAlloc
• ~PyTypeObject.tp_alloc

Like PyObject_New except:

• It allocates enough memory for the TYPE structure plus size (Py_ssize_t) fields of the size given by the ~PyTypeObject.tp_itemsize field of typeobj.
• The memory is initialized like PyObject_InitVar.

This is useful for implementing objects like tuples, which are able to determine their size at construction time. Embedding the array of fields into the same allocation decreases the number of allocations, improving the memory management efficiency.

Avoid calling this directly to allocate memory for an object; call the type's ~PyTypeObject.tp_alloc slot instead.

When populating a type's ~PyTypeObject.tp_alloc slot, PyType_GenericAlloc is preferred over a custom function that simply calls this macro.

This cannot be used for objects with Py_TPFLAGS_HAVE_GC set in ~PyTypeObject.tp_flags; use PyObject_GC_NewVar instead.

Memory allocated by this function must be freed with PyObject_Free (usually called via the object's ~PyTypeObject.tp_free slot).

[!NOTE] The returned memory is not guaranteed to have been completely zeroed before it was initialized.

[!NOTE] This macro does not construct a fully initialized object of the given type; it merely allocates memory and prepares it for further initialization by ~PyTypeObject.tp_init. To construct a fully initialized object, call typeobj instead. For example:

PyObject *list_instance = PyObject_CallNoArgs((PyObject *)&PyList_Type);

• PyObject_Free
• PyObject_GC_NewVar
• PyType_GenericAlloc
• ~PyTypeObject.tp_alloc

Object which is visible in Python as None. This should only be accessed using the Py_None macro, which evaluates to a pointer to this object.

Soft-deprecated aliases

These are aliases to existing functions and macros. They exist solely for backwards compatibility.