FM / c-api

/usr/share/doc/python2-docs/html/_sources/c-api/

/usr/share/doc/python2-docs/html/_sources/c-api

Name	Size	Mode	Actions
abstract.rst.txt	702	0644	edit dl rm
allocation.rst.txt	4796	0644	edit dl rm
arg.rst.txt	26004	0644	edit dl rm
bool.rst.txt	1304	0644	edit dl rm
buffer.rst.txt	22965	0644	edit dl rm
bytearray.rst.txt	2181	0644	edit dl rm
capsule.rst.txt	5741	0644	edit dl rm
cell.rst.txt	1940	0644	edit dl rm
class.rst.txt	1866	0644	edit dl rm
cobject.rst.txt	1870	0644	edit dl rm
code.rst.txt	1635	0644	edit dl rm
codec.rst.txt	4643	0644	edit dl rm
complex.rst.txt	4079	0644	edit dl rm
concrete.rst.txt	1963	0644	edit dl rm
conversion.rst.txt	7092	0644	edit dl rm
datetime.rst.txt	6413	0644	edit dl rm
descriptor.rst.txt	1296	0644	edit dl rm
dict.rst.txt	7757	0644	edit dl rm
exceptions.rst.txt	35304	0644	edit dl rm
file.rst.txt	6198	0644	edit dl rm
float.rst.txt	3371	0644	edit dl rm
function.rst.txt	2421	0644	edit dl rm
gcsupport.rst.txt	6587	0644	edit dl rm
gen.rst.txt	920	0644	edit dl rm
import.rst.txt	11221	0644	edit dl rm
index.rst.txt	578	0644	edit dl rm
init.rst.txt	49160	0644	edit dl rm
int.rst.txt	4578	0644	edit dl rm
intro.rst.txt	28473	0644	edit dl rm
iter.rst.txt	1390	0644	edit dl rm
iterator.rst.txt	1796	0644	edit dl rm
list.rst.txt	6362	0644	edit dl rm
long.rst.txt	7987	0644	edit dl rm
mapping.rst.txt	2874	0644	edit dl rm
marshal.rst.txt	3985	0644	edit dl rm
memory.rst.txt	11556	0644	edit dl rm
method.rst.txt	2099	0644	edit dl rm
module.rst.txt	3867	0644	edit dl rm
none.rst.txt	697	0644	edit dl rm
number.rst.txt	11939	0644	edit dl rm
objbuffer.rst.txt	2516	0644	edit dl rm
object.rst.txt	17491	0644	edit dl rm
objimpl.rst.txt	305	0644	edit dl rm
refcounting.rst.txt	2934	0644	edit dl rm
reflection.rst.txt	1567	0644	edit dl rm
sequence.rst.txt	8716	0644	edit dl rm
set.rst.txt	6588	0644	edit dl rm
slice.rst.txt	2979	0644	edit dl rm
string.rst.txt	15422	0644	edit dl rm
structures.rst.txt	14966	0644	edit dl rm
sys.rst.txt	5714	0644	edit dl rm
tuple.rst.txt	5491	0644	edit dl rm
type.rst.txt	2761	0644	edit dl rm
typeobj.rst.txt	66936	0644	edit dl rm
unicode.rst.txt	45126	0644	edit dl rm
utilities.rst.txt	415	0644	edit dl rm
veryhigh.rst.txt	13363	0644	edit dl rm
weakref.rst.txt	2820	0644	edit dl rm

Edit: /usr/share/doc/python2-docs/html/_sources/c-api/allocation.rst.txt (4796B)

.. 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)

.. versionchanged:: 2.5
      This function used an :c:type:`int` type for *size*. This might require
      changes in your code for properly supporting 64-bit systems.

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

.. 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.

.. versionchanged:: 2.5
      This function used an :c:type:`int` type for *size*. This might require
      changes in your code for properly supporting 64-bit systems.

.. 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.

.. versionchanged:: 2.5
      This function used an :c:type:`int` type for *size*. This might require
      changes in your code for properly supporting 64-bit systems.

.. 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:function:: PyObject* Py_InitModule(char *name, PyMethodDef *methods)

Create a new module object based on a name and table of functions,
   returning the new module object.

.. versionchanged:: 2.3
      Older versions of Python did not support *NULL* as the value for the
      *methods* argument.

.. c:function:: PyObject* Py_InitModule3(char *name, PyMethodDef *methods, char *doc)

Create a new module object based on a name and table of functions,
   returning the new module object.  If *doc* is non-*NULL*, it will be used
   to define the docstring for the module.

.. versionchanged:: 2.3
      Older versions of Python did not support *NULL* as the value for the
      *methods* argument.

.. c:function:: PyObject* Py_InitModule4(char *name, PyMethodDef *methods, char *doc, PyObject *self, int apiver)

Create a new module object based on a name and table of functions,
   returning the new module object.  If *doc* is non-*NULL*, it will be used
   to define the docstring for the module.  If *self* is non-*NULL*, it will
   be passed to the functions of the module as their (otherwise *NULL*) first
   parameter.  (This was added as an experimental feature, and there are no
   known uses in the current version of Python.)  For *apiver*, the only value
   which should be passed is defined by the constant
   :const:`PYTHON_API_VERSION`.

.. note::

Most uses of this function should probably be using the
      :c:func:`Py_InitModule3` instead; only use this if you are sure you need
      it.

.. versionchanged:: 2.3
      Older versions of Python did not support *NULL* as the value for the
      *methods* argument.

.. c:var:: PyObject _Py_NoneStruct

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.

.. 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) .. versionchanged:: 2.5 This function used an :c:type:`int` type for *size*. This might require changes in your code for properly supporting 64-bit systems. .. c:function:: void _PyObject_Del(PyObject *op) .. 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. .. versionchanged:: 2.5 This function used an :c:type:`int` type for *size*. This might require changes in your code for properly supporting 64-bit systems. .. 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. .. versionchanged:: 2.5 This function used an :c:type:`int` type for *size*. This might require changes in your code for properly supporting 64-bit systems. .. 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:function:: PyObject* Py_InitModule(char *name, PyMethodDef *methods) Create a new module object based on a name and table of functions, returning the new module object. .. versionchanged:: 2.3 Older versions of Python did not support *NULL* as the value for the *methods* argument. .. c:function:: PyObject* Py_InitModule3(char *name, PyMethodDef *methods, char *doc) Create a new module object based on a name and table of functions, returning the new module object. If *doc* is non-*NULL*, it will be used to define the docstring for the module. .. versionchanged:: 2.3 Older versions of Python did not support *NULL* as the value for the *methods* argument. .. c:function:: PyObject* Py_InitModule4(char *name, PyMethodDef *methods, char *doc, PyObject *self, int apiver) Create a new module object based on a name and table of functions, returning the new module object. If *doc* is non-*NULL*, it will be used to define the docstring for the module. If *self* is non-*NULL*, it will be passed to the functions of the module as their (otherwise *NULL*) first parameter. (This was added as an experimental feature, and there are no known uses in the current version of Python.) For *apiver*, the only value which should be passed is defined by the constant :const:`PYTHON_API_VERSION`. .. note:: Most uses of this function should probably be using the :c:func:`Py_InitModule3` instead; only use this if you are sure you need it. .. versionchanged:: 2.3 Older versions of Python did not support *NULL* as the value for the *methods* argument. .. c:var:: PyObject _Py_NoneStruct 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.