Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
abstract.rst.txt	723 B	-rw-r--r--
allocation.rst.txt	2.58 KB	-rw-r--r--
apiabiversion.rst.txt	2.31 KB	-rw-r--r--
arg.rst.txt	30.78 KB	-rw-r--r--
bool.rst.txt	1.2 KB	-rw-r--r--
buffer.rst.txt	22.36 KB	-rw-r--r--
bytearray.rst.txt	2.2 KB	-rw-r--r--
bytes.rst.txt	9.2 KB	-rw-r--r--
call.rst.txt	16.56 KB	-rw-r--r--
capsule.rst.txt	5.68 KB	-rw-r--r--
cell.rst.txt	1.94 KB	-rw-r--r--
code.rst.txt	2.56 KB	-rw-r--r--
codec.rst.txt	5.01 KB	-rw-r--r--
complex.rst.txt	4.13 KB	-rw-r--r--
concrete.rst.txt	2.03 KB	-rw-r--r--
contextvars.rst.txt	4.11 KB	-rw-r--r--
conversion.rst.txt	5.39 KB	-rw-r--r--
coro.rst.txt	862 B	-rw-r--r--
datetime.rst.txt	8.46 KB	-rw-r--r--
descriptor.rst.txt	1.08 KB	-rw-r--r--
dict.rst.txt	8.51 KB	-rw-r--r--
exceptions.rst.txt	49.24 KB	-rw-r--r--
file.rst.txt	4.25 KB	-rw-r--r--
float.rst.txt	2.27 KB	-rw-r--r--
function.rst.txt	3.37 KB	-rw-r--r--
gcsupport.rst.txt	8.52 KB	-rw-r--r--
gen.rst.txt	1.35 KB	-rw-r--r--
import.rst.txt	12.61 KB	-rw-r--r--
index.rst.txt	632 B	-rw-r--r--
init.rst.txt	69.48 KB	-rw-r--r--
init_config.rst.txt	48.17 KB	-rw-r--r--
intro.rst.txt	32.03 KB	-rw-r--r--
iter.rst.txt	1.98 KB	-rw-r--r--
iterator.rst.txt	1.67 KB	-rw-r--r--
list.rst.txt	4.61 KB	-rw-r--r--
long.rst.txt	10.72 KB	-rw-r--r--
mapping.rst.txt	3.47 KB	-rw-r--r--
marshal.rst.txt	3.71 KB	-rw-r--r--
memory.rst.txt	29.92 KB	-rw-r--r--
memoryview.rst.txt	2.32 KB	-rw-r--r--
method.rst.txt	2.71 KB	-rw-r--r--
module.rst.txt	22.8 KB	-rw-r--r--
none.rst.txt	736 B	-rw-r--r--
number.rst.txt	10.83 KB	-rw-r--r--
objbuffer.rst.txt	2.39 KB	-rw-r--r--
object.rst.txt	15.14 KB	-rw-r--r--
objimpl.rst.txt	300 B	-rw-r--r--
refcounting.rst.txt	4.18 KB	-rw-r--r--
reflection.rst.txt	1.96 KB	-rw-r--r--
sequence.rst.txt	6.62 KB	-rw-r--r--
set.rst.txt	6.22 KB	-rw-r--r--
slice.rst.txt	4.47 KB	-rw-r--r--
stable.rst.txt	6.44 KB	-rw-r--r--
structures.rst.txt	18.59 KB	-rw-r--r--
sys.rst.txt	16.47 KB	-rw-r--r--
tuple.rst.txt	8.45 KB	-rw-r--r--
type.rst.txt	9.86 KB	-rw-r--r--
typehints.rst.txt	1.67 KB	-rw-r--r--
typeobj.rst.txt	126.97 KB	-rw-r--r--
unicode.rst.txt	67.91 KB	-rw-r--r--
utilities.rst.txt	410 B	-rw-r--r--
veryhigh.rst.txt	15.57 KB	-rw-r--r--
weakref.rst.txt	3.03 KB	-rw-r--r--

Code Editor : function.rst.txt

.. highlight:: c

.. _function-objects:

Function Objects
----------------

.. index:: object: function

There are a few functions specific to Python functions.

.. c:type:: PyFunctionObject

The C structure used for functions.

.. c:var:: PyTypeObject PyFunction_Type

.. index:: single: MethodType (in module types)

This is an instance of :c:type:`PyTypeObject` and represents the Python function
   type.  It is exposed to Python programmers as ``types.FunctionType``.

.. c:function:: int PyFunction_Check(PyObject *o)

Return true if *o* is a function object (has type :c:data:`PyFunction_Type`).
   The parameter must not be ``NULL``.  This function always succeeds.

.. c:function:: PyObject* PyFunction_New(PyObject *code, PyObject *globals)

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 ``NULL``. *__qualname__* is set to the same value as the function's name.

.. c:function:: PyObject* PyFunction_NewWithQualName(PyObject *code, PyObject *globals, PyObject *qualname)

As :c:func:`PyFunction_New`, but also allows setting the function object's
   ``__qualname__`` attribute.  *qualname* should be a unicode object or ``NULL``;
   if ``NULL``, the ``__qualname__`` attribute is set to the same value as its
   ``__name__`` attribute.

.. versionadded:: 3.3

.. c:function:: PyObject* PyFunction_GetCode(PyObject *op)

Return the code object associated with the function object *op*.

.. c:function:: PyObject* PyFunction_GetGlobals(PyObject *op)

Return the globals dictionary associated with the function object *op*.

.. c:function:: PyObject* PyFunction_GetModule(PyObject *op)

Return a :term:`borrowed reference` 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.

.. c:function:: PyObject* PyFunction_GetDefaults(PyObject *op)

Return the argument default values of the function object *op*. This can be a
   tuple of arguments or ``NULL``.

.. c:function:: int PyFunction_SetDefaults(PyObject *op, PyObject *defaults)

Set the argument default values for the function object *op*. *defaults* must be
   ``Py_None`` or a tuple.

Raises :exc:`SystemError` and returns ``-1`` on failure.

.. c:function:: PyObject* PyFunction_GetClosure(PyObject *op)

Return the closure associated with the function object *op*. This can be ``NULL``
   or a tuple of cell objects.

.. c:function:: int PyFunction_SetClosure(PyObject *op, PyObject *closure)

Set the closure associated with the function object *op*. *closure* must be
   ``Py_None`` or a tuple of cell objects.

Raises :exc:`SystemError` and returns ``-1`` on failure.

.. c:function:: PyObject *PyFunction_GetAnnotations(PyObject *op)

Return the annotations of the function object *op*. This can be a
   mutable dictionary or ``NULL``.

.. c:function:: int PyFunction_SetAnnotations(PyObject *op, PyObject *annotations)

Set the annotations for the function object *op*. *annotations*
   must be a dictionary or ``Py_None``.

Raises :exc:`SystemError` and returns ``-1`` on failure.

${this.title}

Code Editor : function.rst.txt