Skip to content

Improve cross-references in runpy docs #107673

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
AlexWaygood merged 8 commits into from
Aug 6, 2023
Merged

Improve cross-references in runpy docs #107673

Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0b2b754
Add missing ticks around variable names
kamilturek Aug 5, 2023
3bae2c1
Bring back capitalisation
kamilturek Aug 6, 2023
c522fc7
Add line break before example
kamilturek Aug 6, 2023
57f6609
Add cross-references to sys.path
kamilturek Aug 6, 2023
c37c1c7
Leave only one link to sys.path per paragraph
kamilturek Aug 6, 2023
4e8e83e
Revert unnecessary line breaks
kamilturek Aug 6, 2023
cef0495
Add cross-references to __main__
kamilturek Aug 6, 2023
a1d94bb
Remove other excessive links
kamilturek Aug 6, 2023
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
13 changes: 7 additions & 6 deletions Doc/library/runpy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,12 @@ The :mod:`runpy` module provides two functions:
Execute the code at the named filesystem location and return the resulting
module globals dictionary. As with a script name supplied to the CPython
command line, the supplied path may refer to a Python source file, a
compiled bytecode file or a valid sys.path entry containing a ``__main__``
module (e.g. a zipfile containing a top-level ``__main__.py`` file).
compiled bytecode file or a valid ``sys.path`` entry containing a
``__main__`` module
(e.g. a zipfile containing a top-level ``__main__.py`` file).

For a simple script, the specified code is simply executed in a fresh
module namespace. For a valid sys.path entry (typically a zipfile or
module namespace. For a valid ``sys.path`` entry (typically a zipfile or
directory), the entry is first added to the beginning of ``sys.path``. The
function then looks for and executes a :mod:`__main__` module using the
updated path. Note that there is no special protection against invoking
Expand All @@ -137,7 +138,7 @@ The :mod:`runpy` module provides two functions:
supplied path, and ``__spec__``, ``__cached__``, ``__loader__`` and
``__package__`` will all be set to :const:`None`.

If the supplied path is a reference to a valid sys.path entry, then
If the supplied path is a reference to a valid ``sys.path`` entry, then
``__spec__`` will be set appropriately for the imported ``__main__``
module (that is, ``__spec__.name`` will always be ``__main__``).
``__file__``, ``__cached__``, ``__loader__`` and ``__package__`` will be
Expand All @@ -152,7 +153,7 @@ The :mod:`runpy` module provides two functions:

Note that, unlike :func:`run_module`, the alterations made to :mod:`sys`
are not optional in this function as these adjustments are essential to
allowing the execution of sys.path entries. As the thread-safety
allowing the execution of ``sys.path`` entries. As the thread-safety
limitations still apply, use of this function in threaded code should be
either serialised with the import lock or delegated to a separate process.

Expand All @@ -165,7 +166,7 @@ The :mod:`runpy` module provides two functions:
.. versionchanged:: 3.4
Updated to take advantage of the module spec feature added by
:pep:`451`. This allows ``__cached__`` to be set correctly in the
case where ``__main__`` is imported from a valid sys.path entry rather
case where ``__main__`` is imported from a valid ``sys.path`` entry rather
than being executed directly.

.. versionchanged:: 3.12
Expand Down