Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-08 06:10:17 +00:00
Code Issues Projects Releases Packages Wiki Activity

[3.14] gh-135755: Document __future__.* and CO_* as proper Sphinx objects (GH-135980) (GH-136370)

Browse source 
* Turn the __future__ table to list-table.
  This'll make it easier to add entries that need longer markup
* Semantic markup for __future__ feature descriptions.
* Document CO_* C macros.

(cherry picked from commit 2468aafe98)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
This commit is contained in:
Miss Islington (bot) 2025-07-07 12:55:20 +02:00 • committed by GitHub
parent f02be2dfe8
commit 5df4f353ad
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 115 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

65
Doc/c-api/code.rst
View file

@ -211,6 +211,71 @@ bound into a function.
.. versionadded:: 3.12
.. _c_codeobject_flags:
Code Object Flags
-----------------
Code objects contain a bit-field of flags, which can be retrieved as the
:attr:`~codeobject.co_flags` Python attribute (for example using
:c:func:`PyObject_GetAttrString`), and set using a *flags* argument to
:c:func:`PyUnstable_Code_New` and similar functions.
Flags whose names start with ``CO_FUTURE_`` correspond to features normally
selectable by :ref:`future statements <future>`. These flags can be used in
:c:member:`PyCompilerFlags.cf_flags`.
Note that many ``CO_FUTURE_`` flags are mandatory in current versions of
Python, and setting them has no effect.
The following flags are available.
For their meaning, see the linked documentation of their Python equivalents.
.. list-table::
:widths: auto
:header-rows: 1
* * Flag
* Meaning
* * .. c:macro:: CO_OPTIMIZED
* :py:data:`inspect.CO_OPTIMIZED`
* * .. c:macro:: CO_NEWLOCALS
* :py:data:`inspect.CO_NEWLOCALS`
* * .. c:macro:: CO_VARARGS
* :py:data:`inspect.CO_VARARGS`
* * .. c:macro:: CO_VARKEYWORDS
* :py:data:`inspect.CO_VARKEYWORDS`
* * .. c:macro:: CO_NESTED
* :py:data:`inspect.CO_NESTED`
* * .. c:macro:: CO_GENERATOR
* :py:data:`inspect.CO_GENERATOR`
* * .. c:macro:: CO_COROUTINE
* :py:data:`inspect.CO_COROUTINE`
* * .. c:macro:: CO_ITERABLE_COROUTINE
* :py:data:`inspect.CO_ITERABLE_COROUTINE`
* * .. c:macro:: CO_ASYNC_GENERATOR
* :py:data:`inspect.CO_ASYNC_GENERATOR`
* * .. c:macro:: CO_HAS_DOCSTRING
* :py:data:`inspect.CO_HAS_DOCSTRING`
* * .. c:macro:: CO_METHOD
* :py:data:`inspect.CO_METHOD`
* * .. c:macro:: CO_FUTURE_DIVISION
* no effect (:py:data:`__future__.division`)
* * .. c:macro:: CO_FUTURE_ABSOLUTE_IMPORT
* no effect (:py:data:`__future__.absolute_import`)
* * .. c:macro:: CO_FUTURE_WITH_STATEMENT
* no effect (:py:data:`__future__.with_statement`)
* * .. c:macro:: CO_FUTURE_PRINT_FUNCTION
* no effect (:py:data:`__future__.print_function`)
* * .. c:macro:: CO_FUTURE_UNICODE_LITERALS
* no effect (:py:data:`__future__.unicode_literals`)
* * .. c:macro:: CO_FUTURE_GENERATOR_STOP
* no effect (:py:data:`__future__.generator_stop`)
* * .. c:macro:: CO_FUTURE_ANNOTATIONS
* :py:data:`__future__.annotations`
Extra information
-----------------