SWAMPy

✎ CARVE FLESH

EDITING: allocation.rst.txt

.. highlightlang:: c

.. _allocating-objects:

Allocating Objects on the Heap
==============================

.. c:function:: PyObject* _PyObject_New(PyTypeObject *type)

.. c:function:: PyVarObject* _PyObject_NewVar(PyTypeObject *type, Py_ssize_t size)

.. c:function:: PyObject* PyObject_Init(PyObject *op, PyTypeObject *type)

Initialize a newly-allocated object *op* with its type and initial
   reference.  Returns the initialized object.  If *type* indicates that the
   object participates in the cyclic garbage detector, it is added to the
   detector's set of observed objects. Other fields of the object are not
   affected.

.. c:function:: PyVarObject* PyObject_InitVar(PyVarObject *op, PyTypeObject *type, Py_ssize_t size)

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

.. c:function:: TYPE* PyObject_New(TYPE, PyTypeObject *type)

Allocate a new Python object using the C structure type *TYPE* and the
   Python type object *type*.  Fields not defined by the Python object header
   are not initialized; the object's reference count will be one.  The size of
   the memory allocation is determined from the :c:member:`~PyTypeObject.tp_basicsize` field of
   the type object.

.. c:function:: TYPE* PyObject_NewVar(TYPE, PyTypeObject *type, Py_ssize_t size)

Allocate a new Python object using the C structure type *TYPE* and the
   Python type object *type*.  Fields not defined by the Python object header
   are not initialized.  The allocated memory allows for the *TYPE* structure
   plus *size* fields of the size given by the :c:member:`~PyTypeObject.tp_itemsize` field of
   *type*.  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.

.. c:function:: void PyObject_Del(PyObject *op)

Releases memory allocated to an object using :c:func:`PyObject_New` or
   :c:func:`PyObject_NewVar`.  This is normally called from the
   :c:member:`~PyTypeObject.tp_dealloc` handler specified in the object's type.  The fields of
   the object should not be accessed after this call as the memory is no
   longer a valid Python object.

.. c:var:: PyObject _Py_NoneStruct

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

.. seealso::

:c:func:`PyModule_Create`
      To allocate and create extension modules.

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 abstract.rst.txt	TXT	715 B	2018-10-20 05:24	EDIT
📄 allocation.rst.txt	TXT	2.6 KB	2018-10-20 05:24	EDIT
📄 apiabiversion.rst.txt	TXT	2.2 KB	2018-10-20 05:24	EDIT
📄 arg.rst.txt	TXT	29.9 KB	2018-10-20 05:24	EDIT
📄 bool.rst.txt	TXT	1.2 KB	2018-10-20 05:24	EDIT
📄 buffer.rst.txt	TXT	21.7 KB	2018-10-20 05:24	EDIT
📄 bytearray.rst.txt	TXT	2.2 KB	2018-10-20 05:24	EDIT
📄 bytes.rst.txt	TXT	9 KB	2018-10-20 05:24	EDIT
📄 capsule.rst.txt	TXT	5.6 KB	2018-10-20 05:24	EDIT
📄 cell.rst.txt	TXT	1.9 KB	2018-10-20 05:24	EDIT
📄 code.rst.txt	TXT	1.6 KB	2018-10-20 05:24	EDIT
📄 codec.rst.txt	TXT	4.7 KB	2018-10-20 05:24	EDIT
📄 complex.rst.txt	TXT	3.9 KB	2018-10-20 05:24	EDIT
📄 concrete.rst.txt	TXT	2 KB	2018-10-20 05:24	EDIT
📄 conversion.rst.txt	TXT	5.4 KB	2018-10-20 05:24	EDIT
📄 coro.rst.txt	TXT	820 B	2018-10-20 05:24	EDIT
📄 datetime.rst.txt	TXT	6.3 KB	2018-10-20 05:24	EDIT
📄 descriptor.rst.txt	TXT	1.1 KB	2018-10-20 05:24	EDIT
📄 dict.rst.txt	TXT	7.8 KB	2018-10-20 05:24	EDIT
📄 exceptions.rst.txt	TXT	46.7 KB	2018-10-20 05:24	EDIT
📄 file.rst.txt	TXT	3.2 KB	2018-10-20 05:24	EDIT
📄 float.rst.txt	TXT	2.2 KB	2018-10-20 05:24	EDIT
📄 function.rst.txt	TXT	3.3 KB	2018-10-20 05:24	EDIT
📄 gcsupport.rst.txt	TXT	5.9 KB	2018-10-20 05:24	EDIT
📄 gen.rst.txt	TXT	1.3 KB	2018-10-20 05:24	EDIT
📄 import.rst.txt	TXT	12.5 KB	2018-10-20 05:24	EDIT
📄 index.rst.txt	TXT	613 B	2018-10-20 05:24	EDIT
📄 init.rst.txt	TXT	51.2 KB	2018-10-20 05:24	EDIT
📄 intro.rst.txt	TXT	28.1 KB	2018-10-20 05:24	EDIT
📄 iter.rst.txt	TXT	1.1 KB	2018-10-20 05:24	EDIT
📄 iterator.rst.txt	TXT	1.6 KB	2018-10-20 05:24	EDIT
📄 list.rst.txt	TXT	4.6 KB	2018-10-20 05:24	EDIT
📄 long.rst.txt	TXT	10.2 KB	2018-10-20 05:24	EDIT
📄 mapping.rst.txt	TXT	2.8 KB	2018-10-20 05:24	EDIT
📄 marshal.rst.txt	TXT	3.5 KB	2018-10-20 05:24	EDIT
📄 memory.rst.txt	TXT	20.9 KB	2018-10-20 05:24	EDIT
📄 memoryview.rst.txt	TXT	2.3 KB	2018-10-20 05:24	EDIT
📄 method.rst.txt	TXT	2.8 KB	2018-10-20 05:24	EDIT
📄 module.rst.txt	TXT	17.8 KB	2018-10-20 05:24	EDIT
📄 none.rst.txt	TXT	740 B	2018-10-20 05:24	EDIT
📄 number.rst.txt	TXT	10.3 KB	2018-10-20 05:24	EDIT
📄 objbuffer.rst.txt	TXT	2.1 KB	2018-10-20 05:24	EDIT
📄 object.rst.txt	TXT	17 KB	2018-10-20 05:24	EDIT
📄 objimpl.rst.txt	TXT	304 B	2018-10-20 05:24	EDIT
📄 refcounting.rst.txt	TXT	2.8 KB	2018-10-20 05:24	EDIT
📄 reflection.rst.txt	TXT	1.4 KB	2018-10-20 05:24	EDIT
📄 sequence.rst.txt	TXT	6.4 KB	2018-10-20 05:24	EDIT
📄 set.rst.txt	TXT	6 KB	2018-10-20 05:24	EDIT
📄 slice.rst.txt	TXT	2.3 KB	2018-10-20 05:24	EDIT
📄 stable.rst.txt	TXT	1.9 KB	2018-10-20 05:24	EDIT
📄 structures.rst.txt	TXT	13.5 KB	2018-10-20 05:24	EDIT
📄 sys.rst.txt	TXT	9.7 KB	2018-10-20 05:24	EDIT
📄 tuple.rst.txt	TXT	7.8 KB	2018-10-20 05:24	EDIT
📄 type.rst.txt	TXT	3.9 KB	2018-10-20 05:24	EDIT
📄 typeobj.rst.txt	TXT	58.8 KB	2018-10-20 05:24	EDIT
📄 unicode.rst.txt	TXT	66.5 KB	2018-10-20 05:24	EDIT
📄 utilities.rst.txt	TXT	414 B	2018-10-20 05:24	EDIT
📄 veryhigh.rst.txt	TXT	16.3 KB	2018-10-20 05:24	EDIT
📄 weakref.rst.txt	TXT	2.6 KB	2018-10-20 05:24	EDIT