*_PyObject_New(
*type)
Return value: New reference.
*_PyObject_NewVar(
*type,
size)
Return value: New reference.
*PyObject_Init(
*op,
*type)
Return value: Borrowed reference. Part of the
.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
method (
slot). Specifically, this function does not call the object’s __init__() method.
In general, consider this function to be a low-level routine. Use
where possible. For implementing tp_alloc for your type, prefer
or
.
Note
This function only initializes the object’s memory corresponding to the initial
structure. It does not zero the rest.
*PyObject_InitVar(
*op,
*type,
size)
Return value: Borrowed reference. Part of the
.This does everything
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.
PyObject_New(TYPE, typeobj)
Allocates a new Python object using the C structure type TYPE and the Python type object typeobj (PyTypeObject*) by calling
to allocate memory and initializing it like
. 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
slot instead.
When populating a type’s
slot,
is preferred over a custom function that simply calls this macro.
This macro does not call
,
(
), or
(
).
This cannot be used for objects with
set in
; use
instead.
Memory allocated by this macro must be freed with
(usually called via the object’s
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
. To construct a fully initialized object, call typeobj instead. For example:
PyObject*foo=PyObject_CallNoArgs((PyObject*)&PyFoo_Type);PyObject_NewVar(TYPE, typeobj, size)
Like
except:
It allocates enough memory for the TYPE structure plus size (Py_ssize_t) fields of the size given by the
field of typeobj.
The memory is initialized like
.
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
slot instead.
When populating a type’s
slot,
is preferred over a custom function that simply calls this macro.
This cannot be used for objects with
set in
; use
instead.
Memory allocated by this function must be freed with
(usually called via the object’s
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
. To construct a fully initialized object, call typeobj instead. For example:
PyObject*list_instance=PyObject_CallNoArgs((PyObject*)&PyList_Type);
_Py_NoneStruct
Object which is visible in Python as None. This should only be accessed using the
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.
Soft-deprecated alias
Function
PyObject_NEW(type, typeobj)
PyObject_NEW_VAR(type, typeobj, n)
PyObject_INIT(op, typeobj)
PyObject_INIT_VAR(op, typeobj, n)
PyObject_MALLOC(n)
PyObject_REALLOC(p, n)
PyObject_FREE(p)
PyObject_DEL(p)
PyObject_Del(p)