07cdfd23373b17c6b337251c22b7ea57

Edit file

File name : function.html

Content :

<!DOCTYPE html>

<title>Function Objects &#8212; Python 3.10.12 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?2022.1" />
 
 <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 3.10.12 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="Instance Method Objects" href="method.html" />
 <link rel="prev" title="Set Objects" href="set.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/c-api/function.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <label for="menuToggler" class="toggler__label">
 
 </label>
 <nav class="nav-content" role="navigation">
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Logo"/>
 </a>
 <div class="version_switcher_placeholder"></div>
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero"
 d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z" fill="#444"></path>
 </svg>
 <input type="text" name="q" aria-label="Quick search"/>
 <input type="submit" value="Go"/>
 </form>
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 <h4>Previous topic</h4>
 <a href="set.html"
 title="previous chapter">Set Objects</a>
 <h4>Next topic</h4>
 <a href="method.html"
 title="next chapter">Instance Method Objects</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/c-api/function.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </nav>
 </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"
 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="method.html" title="Instance Method Objects"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="set.html" title="Set Objects"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.10.12 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="concrete.html" accesskey="U">Concrete Objects Layer</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Function Objects</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="function-objects">
<h1>Function Objects<a class="headerlink" href="#function-objects" title="Permalink to this headline">¶</a></h1>
There are a few functions specific to Python functions.
<dl class="c type">
<dt class="sig sig-object c" id="c.PyFunctionObject">
type PyFunctionObject<a class="headerlink" href="#c.PyFunctionObject" title="Permalink to this definition">¶</a> </dt>
<dd>The C structure used for functions.
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c.PyFunction_Type">
<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> PyFunction_Type<a class="headerlink" href="#c.PyFunction_Type" title="Permalink to this definition">¶</a> </dt>
<dd>This is an instance of <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><code class="xref c c-type docutils literal notranslate">PyTypeObject</code></a> and represents the Python function
type. It is exposed to Python programmers as <code class="docutils literal notranslate">types.FunctionType</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFunction_Check">
int PyFunction_Check(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyFunction_Check" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if o is a function object (has type <a class="reference internal" href="#c.PyFunction_Type" title="PyFunction_Type"><code class="xref c c-data docutils literal notranslate">PyFunction_Type</code></a>).
The parameter must not be <code class="docutils literal notranslate">NULL</code>. This function always succeeds.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFunction_New">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyFunction_New(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *code, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *globals)<a class="headerlink" href="#c.PyFunction_New" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Return a new function object associated with the code object code. globals
must be a dictionary with the global variables accessible to the function.
The function’s docstring and name are retrieved from the code object. __module__
is retrieved from globals. The argument defaults, annotations and closure are
set to <code class="docutils literal notranslate">NULL</code>. __qualname__ is set to the same value as the function’s name.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFunction_NewWithQualName">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyFunction_NewWithQualName(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *code, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *globals, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *qualname)<a class="headerlink" href="#c.PyFunction_NewWithQualName" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.As <a class="reference internal" href="#c.PyFunction_New" title="PyFunction_New"><code class="xref c c-func docutils literal notranslate">PyFunction_New()</code></a>, but also allows setting the function object’s
<code class="docutils literal notranslate">__qualname__</code> attribute. qualname should be a unicode object or <code class="docutils literal notranslate">NULL</code>;
if <code class="docutils literal notranslate">NULL</code>, the <code class="docutils literal notranslate">__qualname__</code> attribute is set to the same value as its
<code class="docutils literal notranslate">__name__</code> attribute.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFunction_GetCode">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyFunction_GetCode(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *op)<a class="headerlink" href="#c.PyFunction_GetCode" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: Borrowed reference.Return the code object associated with the function object op.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFunction_GetGlobals">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyFunction_GetGlobals(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *op)<a class="headerlink" href="#c.PyFunction_GetGlobals" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: Borrowed reference.Return the globals dictionary associated with the function object op.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFunction_GetModule">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyFunction_GetModule(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *op)<a class="headerlink" href="#c.PyFunction_GetModule" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: Borrowed reference.Return a <a class="reference internal" href="../glossary.html#term-borrowed-reference">borrowed reference</a> to the __module__ attribute of the
function object op. It can be NULL.
This is normally a string containing the module name, but can be set to any
other object by Python code.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFunction_GetDefaults">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyFunction_GetDefaults(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *op)<a class="headerlink" href="#c.PyFunction_GetDefaults" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: Borrowed reference.Return the argument default values of the function object op. This can be a
tuple of arguments or <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFunction_SetDefaults">
int PyFunction_SetDefaults(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *op, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *defaults)<a class="headerlink" href="#c.PyFunction_SetDefaults" title="Permalink to this definition">¶</a> </dt>
<dd>Set the argument default values for the function object op. defaults must be
<code class="docutils literal notranslate">Py_None</code> or a tuple.
Raises <a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal notranslate">SystemError</code></a> and returns <code class="docutils literal notranslate">-1</code> on failure.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFunction_GetClosure">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyFunction_GetClosure(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *op)<a class="headerlink" href="#c.PyFunction_GetClosure" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: Borrowed reference.Return the closure associated with the function object op. This can be <code class="docutils literal notranslate">NULL</code>
or a tuple of cell objects.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFunction_SetClosure">
int PyFunction_SetClosure(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *op, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *closure)<a class="headerlink" href="#c.PyFunction_SetClosure" title="Permalink to this definition">¶</a> </dt>
<dd>Set the closure associated with the function object op. closure must be
<code class="docutils literal notranslate">Py_None</code> or a tuple of cell objects.
Raises <a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal notranslate">SystemError</code></a> and returns <code class="docutils literal notranslate">-1</code> on failure.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFunction_GetAnnotations">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyFunction_GetAnnotations(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *op)<a class="headerlink" href="#c.PyFunction_GetAnnotations" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: Borrowed reference.Return the annotations of the function object op. This can be a
mutable dictionary or <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFunction_SetAnnotations">
int PyFunction_SetAnnotations(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *op, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *annotations)<a class="headerlink" href="#c.PyFunction_SetAnnotations" title="Permalink to this definition">¶</a> </dt>
<dd>Set the annotations for the function object op. annotations
must be a dictionary or <code class="docutils literal notranslate">Py_None</code>.
Raises <a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal notranslate">SystemError</code></a> and returns <code class="docutils literal notranslate">-1</code> on failure.
</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="set.html"
 title="previous chapter">Set Objects</a>
 <h4>Next topic</h4>
 <a href="method.html"
 title="next chapter">Instance Method Objects</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/c-api/function.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </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="method.html" title="Instance Method Objects"
 >next</a> |</li>
 <li class="right" >
 <a href="set.html" title="Set Objects"
 >previous</a> |</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="concrete.html" >Concrete Objects Layer</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Function Objects</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" type="text" name="q" />
 <input type="submit" value="Go" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
 </div>
 |
 </li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 2001-2025, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on February 04, 2025.
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>