Gecko [ v99win.today ]

Name	Size	Permission
abstract.html	7.8 KB	-rw-r--r--
allocation.html	24.04 KB	-rw-r--r--
arg.html	64.25 KB	-rw-r--r--
bool.html	11.44 KB	-rw-r--r--
buffer.html	58.49 KB	-rw-r--r--
bytearray.html	18.39 KB	-rw-r--r--
capsule.html	26.78 KB	-rw-r--r--
cell.html	13.74 KB	-rw-r--r--
class.html	14.3 KB	-rw-r--r--
cobject.html	15.67 KB	-rw-r--r--
code.html	15.57 KB	-rw-r--r--
codec.html	29.28 KB	-rw-r--r--
complex.html	25.03 KB	-rw-r--r--
concrete.html	15.93 KB	-rw-r--r--
conversion.html	29.24 KB	-rw-r--r--
datetime.html	35.92 KB	-rw-r--r--
descriptor.html	15.74 KB	-rw-r--r--
dict.html	42.03 KB	-rw-r--r--
exceptions.html	112.66 KB	-rw-r--r--
file.html	28.8 KB	-rw-r--r--
float.html	21.5 KB	-rw-r--r--
function.html	17.69 KB	-rw-r--r--
gcsupport.html	29.5 KB	-rw-r--r--
gen.html	9.84 KB	-rw-r--r--
import.html	43.14 KB	-rw-r--r--
index.html	13.69 KB	-rw-r--r--
init.html	122.91 KB	-rw-r--r--
int.html	24.28 KB	-rw-r--r--
intro.html	57.73 KB	-rw-r--r--
iter.html	11.38 KB	-rw-r--r--
iterator.html	13.32 KB	-rw-r--r--
list.html	31.45 KB	-rw-r--r--
long.html	39.54 KB	-rw-r--r--
mapping.html	20.85 KB	-rw-r--r--
marshal.html	18.82 KB	-rw-r--r--
memory.html	37.51 KB	-rw-r--r--
method.html	16.77 KB	-rw-r--r--
module.html	21.95 KB	-rw-r--r--
none.html	8.76 KB	-rw-r--r--
number.html	64.95 KB	-rw-r--r--
objbuffer.html	14.62 KB	-rw-r--r--
object.html	74.9 KB	-rw-r--r--
objimpl.html	7.59 KB	-rw-r--r--
refcounting.html	14.46 KB	-rw-r--r--
reflection.html	12.81 KB	-rw-r--r--
sequence.html	41.73 KB	-rw-r--r--
set.html	35.44 KB	-rw-r--r--
slice.html	16.89 KB	-rw-r--r--
string.html	46.73 KB	-rw-r--r--
structures.html	41.96 KB	-rw-r--r--
sys.html	26.72 KB	-rw-r--r--
tuple.html	27.17 KB	-rw-r--r--
type.html	19.18 KB	-rw-r--r--
typeobj.html	209.91 KB	-rw-r--r--
unicode.html	160.87 KB	-rw-r--r--
utilities.html	7.88 KB	-rw-r--r--
veryhigh.html	66.91 KB	-rw-r--r--
weakref.html	15.68 KB	-rw-r--r--

Code Editor : allocation.html

<!DOCTYPE html>

<title>Allocating Objects on the Heap &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="Common Object Structures" href="structures.html" />
 <link rel="prev" title="Object Implementation Support" href="objimpl.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/c-api/allocation.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/c-api/allocation.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="structures.html" title="Common Object Structures"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="objimpl.html" title="Object Implementation Support"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="objimpl.html" accesskey="U">Object Implementation Support</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Allocating Objects on the Heap</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="allocating-objects-on-the-heap">
<h1>Allocating Objects on the Heap<a class="headerlink" href="#allocating-objects-on-the-heap" title="Permalink to this headline">¶</a></h1>
<dl class="c function">
<dt class="sig sig-object c" id="c._PyObject_New">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *_PyObject_New(<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c._PyObject_New" title="Permalink to this definition">¶</a> </dt>
<dd></dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c._PyObject_NewVar">
<a class="reference internal" href="structures.html#c.PyVarObject" title="PyVarObject">PyVarObject</a> *_PyObject_NewVar(<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type, Py_ssize_t size)<a class="headerlink" href="#c._PyObject_NewVar" title="Permalink to this definition">¶</a> </dt>
<dd><div class="versionchanged">
Changed in version 2.5: This function used an <code class="xref c c-type docutils literal notranslate">int</code> type for size. This might require
changes in your code for properly supporting 64-bit systems.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c._PyObject_Del">
void _PyObject_Del(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *op)<a class="headerlink" href="#c._PyObject_Del" title="Permalink to this definition">¶</a> </dt>
<dd></dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyObject_Init">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyObject_Init(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *op, <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyObject_Init" title="Permalink to this definition">¶</a> </dt>
<dd>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.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyObject_InitVar">
<a class="reference internal" href="structures.html#c.PyVarObject" title="PyVarObject">PyVarObject</a> *PyObject_InitVar(<a class="reference internal" href="structures.html#c.PyVarObject" title="PyVarObject">PyVarObject</a> *op, <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type, Py_ssize_t size)<a class="headerlink" href="#c.PyObject_InitVar" title="Permalink to this definition">¶</a> </dt>
<dd>This does everything <a class="reference internal" href="#c.PyObject_Init" title="PyObject_Init"><code class="xref c c-func docutils literal notranslate">PyObject_Init()</code></a> does, and also initializes the
length information for a variable-size object.
<div class="versionchanged">
Changed in version 2.5: This function used an <code class="xref c c-type docutils literal notranslate">int</code> type for size. This might require
changes in your code for properly supporting 64-bit systems.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyObject_New">
TYPE *PyObject_New(TYPE, <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyObject_New" title="Permalink to this definition">¶</a> </dt>
<dd>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 <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_basicsize" title="PyTypeObject.tp_basicsize"><code class="xref c c-member docutils literal notranslate">tp_basicsize</code></a> field of
the type object.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyObject_NewVar">
TYPE *PyObject_NewVar(TYPE, <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type, Py_ssize_t size)<a class="headerlink" href="#c.PyObject_NewVar" title="Permalink to this definition">¶</a> </dt>
<dd>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 <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_itemsize" title="PyTypeObject.tp_itemsize"><code class="xref c c-member docutils literal notranslate">tp_itemsize</code></a> 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.
<div class="versionchanged">
Changed in version 2.5: This function used an <code class="xref c c-type docutils literal notranslate">int</code> type for size. This might require
changes in your code for properly supporting 64-bit systems.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyObject_Del">
void PyObject_Del(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *op)<a class="headerlink" href="#c.PyObject_Del" title="Permalink to this definition">¶</a> </dt>
<dd>Releases memory allocated to an object using <a class="reference internal" href="#c.PyObject_New" title="PyObject_New"><code class="xref c c-func docutils literal notranslate">PyObject_New()</code></a> or
<a class="reference internal" href="#c.PyObject_NewVar" title="PyObject_NewVar"><code class="xref c c-func docutils literal notranslate">PyObject_NewVar()</code></a>. This is normally called from the
<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_dealloc" title="PyTypeObject.tp_dealloc"><code class="xref c c-member docutils literal notranslate">tp_dealloc</code></a> 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.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_InitModule">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *Py_InitModule(char *name, <a class="reference internal" href="structures.html#c.PyMethodDef" title="PyMethodDef">PyMethodDef</a> *methods)<a class="headerlink" href="#c.Py_InitModule" title="Permalink to this definition">¶</a> </dt>
<dd>Create a new module object based on a name and table of functions,
returning the new module object.
<div class="versionchanged">
Changed in version 2.3: Older versions of Python did not support NULL as the value for the
methods argument.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_InitModule3">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *Py_InitModule3(char *name, <a class="reference internal" href="structures.html#c.PyMethodDef" title="PyMethodDef">PyMethodDef</a> *methods, char *doc)<a class="headerlink" href="#c.Py_InitModule3" title="Permalink to this definition">¶</a> </dt>
<dd>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.
<div class="versionchanged">
Changed in version 2.3: Older versions of Python did not support NULL as the value for the
methods argument.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_InitModule4">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *Py_InitModule4(char *name, <a class="reference internal" href="structures.html#c.PyMethodDef" title="PyMethodDef">PyMethodDef</a> *methods, char *doc, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *self, int apiver)<a class="headerlink" href="#c.Py_InitModule4" title="Permalink to this definition">¶</a> </dt>
<dd>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
<code class="xref py py-const docutils literal notranslate">PYTHON_API_VERSION</code>.
<div class="admonition note">
Note
Most uses of this function should probably be using the
<a class="reference internal" href="#c.Py_InitModule3" title="Py_InitModule3"><code class="xref c c-func docutils literal notranslate">Py_InitModule3()</code></a> instead; only use this if you are sure you need
it.
</div>
<div class="versionchanged">
Changed in version 2.3: Older versions of Python did not support NULL as the value for the
methods argument.
</div>
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c._Py_NoneStruct">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> _Py_NoneStruct<a class="headerlink" href="#c._Py_NoneStruct" title="Permalink to this definition">¶</a> </dt>
<dd>Object which is visible in Python as <code class="docutils literal notranslate">None</code>. This should only be
accessed using the <code class="docutils literal notranslate">Py_None</code> macro, which evaluates to a pointer to this
object.
</dd></dl>

</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h4>Previous topic</h4>
 <a href="objimpl.html"
 title="previous chapter">Object Implementation Support</a>
 <h4>Next topic</h4>
 <a href="structures.html"
 title="next chapter">Common Object Structures</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/c-api/allocation.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="structures.html" title="Common Object Structures"
 >next</a> |</li>
 <li class="right" >
 <a href="objimpl.html" title="Object Implementation Support"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="objimpl.html" >Object Implementation Support</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Allocating Objects on the Heap</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on December 09, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : allocation.html