Skip to content

[3.13] gh-74955: Document that __all__ must contain strings in normalization form NFKC (GH-144504) #144520

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

Open
miss-islington wants to merge 1 commit into
base: 3.13
Choose a base branch
from
+5 −1
Open

[3.13] gh-74955: Document that __all__ must contain strings in normalization form NFKC (GH-144504) #144520

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion Doc/reference/simple_stmts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -832,9 +832,11 @@
.. attribute:: module.__all__
:no-typesetting:

The *public names* defined by a module are determined by checking the module's

Check warning on line 835 in Doc/reference/simple_stmts.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

undefined label: 'lexical-names-nonascii' [ref.ref]
namespace for a variable named ``__all__``; if defined, it must be a sequence
of strings which are names defined or imported by that module. The names
of strings which are names defined or imported by that module.
Names containing non-ASCII characters must be in the `normalization form`_
Copy link
Contributor

@caje731 caje731 Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: repetition:
s/must be in the normalization form NFKC / must be in the Normalization Form KC/

or even
s/must be in the normalization form NFKC / must be in NFKC/

First reads well to me

NFKC; see :ref:`lexical-names-nonascii` for details. The names
Copy link
Member

@StanFromIreland StanFromIreland Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
NFKC; see :ref:`lexical-names-nonascii` for details. The names
NFKC. The names

It does not exist in 3.13

Copy link
Contributor

@caje731 caje731 Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Broken on 3.14 too

given in ``__all__`` are all considered public and are required to exist. If
``__all__`` is not defined, the set of public names includes all names found
in the module's namespace which do not begin with an underscore character
Expand Down Expand Up @@ -868,6 +870,8 @@

.. audit-event:: import module,filename,sys.path,sys.meta_path,sys.path_hooks import

.. _normalization form: https://www.unicode.org/reports/tr15/#Norm_Forms

.. _future:

Future statements
Expand Down
Loading