summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/function.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/c-api/function.rst')
-rw-r--r--Doc/c-api/function.rst41
1 files changed, 8 insertions, 33 deletions
diff --git a/Doc/c-api/function.rst b/Doc/c-api/function.rst
index bb416f4..66f8675 100644
--- a/Doc/c-api/function.rst
+++ b/Doc/c-api/function.rst
@@ -1,4 +1,4 @@
-.. highlight:: c
+.. highlightlang:: c
.. _function-objects:
@@ -26,7 +26,7 @@ There are a few functions specific to Python functions.
.. 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``.
+ The parameter must not be *NULL*.
.. c:function:: PyObject* PyFunction_New(PyObject *code, PyObject *globals)
@@ -34,19 +34,8 @@ There are a few functions specific to Python functions.
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
+ The function's docstring, name and *__module__* are retrieved from the code
+ object, the argument defaults and closure are set to *NULL*.
.. c:function:: PyObject* PyFunction_GetCode(PyObject *op)
@@ -69,40 +58,26 @@ There are a few functions specific to Python functions.
.. 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``.
+ 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.
+ *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``
+ 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``.
+ *Py_None* or a tuple of cell objects.
Raises :exc:`SystemError` and returns ``-1`` on failure.