◐ Shell
reader mode source ↗
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
File filter
Conversations
Jump to
Diff view
Apply and reload
Show whitespace
Diff view
Apply and reload
4 changes: 2 additions & 2 deletions developer-workflow/c-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,12 @@ C API Tests
Tests for the public C API live in the ``_testcapi`` module.
Functions named ``test_*`` are used as tests directly.
Tests that need Python code (or are just easier to partially write in Python)
live in ``Lib/test``, mainly in :file:`Lib/test/test_capi.py`.

Due to its size, the ``_testcapi`` module is defined in several source
files.
To add a new set of tests (or extract a set out of the monolithic
:file:`Modules/_testcapimodule.c`):

- Create a C file named ``Modules/_testcapi/yourfeature.c``

Expand Down
49 changes: 26 additions & 23 deletions developer-workflow/grammar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Abstract
========

There's more to changing Python's grammar than editing
:file:`Grammar/python.gram`. Here's a checklist.

.. note::
These instructions are for Python 3.9 and beyond. Earlier
Expand All @@ -25,42 +25,45 @@ Checklist

Note: sometimes things mysteriously don't work. Before giving up, try ``make clean``.

* :file:`Grammar/python.gram`: The grammar, with actions that build AST nodes. After changing
it, run ``make regen-pegen`` (or ``build.bat --regen`` on Windows), to
regenerate :file:`Parser/parser.c`.
(This runs Python's parser generator, ``Tools/peg_generator``).

* :file:`Grammar/Tokens` is a place for adding new token types. After
changing it, run ``make regen-token`` to regenerate :file:`Include/token.h`,
:file:`Parser/token.c`, :file:`Lib/token.py` and
:file:`Doc/library/token-list.inc`. If you change both ``python.gram`` and ``Tokens``,
run ``make regen-token`` before ``make regen-pegen``. On Windows,
``build.bat --regen`` will regenerate both at the same time.

* :file:`Parser/Python.asdl` may need changes to match the grammar. Then run ``make
regen-ast`` to regenerate :file:`Include/Python-ast.h` and :file:`Python/Python-ast.c`.

* :file:`Parser/tokenizer.c` contains the tokenization code. This is where you would
add a new type of comment or string literal, for example.

* :file:`Python/ast.c` will need changes to validate AST objects involved with the
grammar change.

* :file:`Python/ast_unparse.c` will need changes to unparse AST objects involved with the
grammar change ("unparsing" is used to turn annotations into strings per :pep:`563`).

* The :ref:`compiler` has its own page.

* ``_Unparser`` in the :file:`Lib/ast.py` file may need changes to accommodate
any modifications in the AST nodes.

* :file:`Doc/library/ast.rst` may need to be updated to reflect changes to AST nodes.

* Add some usage of your new syntax to ``test_grammar.py``.

* Certain changes may require tweaks to the library module :mod:`pyclbr`.

* :file:`Lib/tokenize.py` needs changes to match changes to the tokenizer.

* Documentation must be written! Specifically, one or more of the pages in
:file:`Doc/reference/` will need to be updated.
2 changes: 1 addition & 1 deletion getting-started/git-boot-camp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ Exclude generated files from diff by default::
git config diff.generated.binary true

The ``generated`` `attribute <https://git-scm.com/docs/gitattributes>`_ is
defined in :file:`.gitattributes`, found in the repository root.

.. _push-changes:

Expand Down
Loading
Toggle all file notes Toggle all file annotations