Skip to content

gh-118915: C API: Document compiler flag macros #129028

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 20, 2025
Merged

gh-118915: C API: Document compiler flag macros #129028

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fb44e8a
C API: Document compiler flag macros
ZeroIntensity Jan 19, 2025
8709a4d
Reorganize compiler flag docs
encukou Jan 20, 2025
cf2d59f
Merge pull request #3 from encukou/document-c-api-compiler-flags
ZeroIntensity Jan 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 12 additions & 17 deletions Doc/c-api/veryhigh.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,8 +333,6 @@ the same library that the Python runtime is using.
equal to ``0``, and any modification due to ``from __future__ import`` is
discarded.

The available :ref:`compiler flags <ast-compiler-flags>` are accessible as macros.

.. c:member:: int cf_flags

Compiler flags.
Expand All @@ -350,23 +348,20 @@ the same library that the Python runtime is using.
.. versionchanged:: 3.8
Added *cf_feature_version* field.

.. c:macro:: PyCF_ALLOW_TOP_LEVEL_AWAIT

Equivalent to :data:`ast.PyCF_ALLOW_TOP_LEVEL_AWAIT`.

.. c:macro:: PyCF_ONLY_AST

Equivalent to :data:`ast.PyCF_ONLY_AST`.

.. c:macro:: PyCF_OPTIMIZED_AST
The available compiler flags are accessible as macros:

Equivalent to :data:`ast.PyCF_OPTIMIZED_AST`.
.. c:namespace:: NULL

.. c:macro:: PyCF_TYPE_COMMENTS
.. c:macro:: PyCF_ALLOW_TOP_LEVEL_AWAIT
PyCF_ONLY_AST
PyCF_OPTIMIZED_AST
PyCF_TYPE_COMMENTS

Equivalent to :data:`ast.PyCF_TYPE_COMMENTS`.
See :ref:`compiler flags <ast-compiler-flags>` in documentation of the
:py:mod:`!ast` Python module, which exports these constants under
the same names.

.. c:var:: int CO_FUTURE_DIVISION
.. c:var:: int CO_FUTURE_DIVISION

This bit can be set in *flags* to cause division operator ``/`` to be
interpreted as "true division" according to :pep:`238`.
This bit can be set in *flags* to cause division operator ``/`` to be
interpreted as "true division" according to :pep:`238`.
Loading