Skip to content

Correct typos in runpy.run_path documentation #151230

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
underscore-andthereitgoes wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

Correct typos in runpy.run_path documentation #151230

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
10 changes: 5 additions & 5 deletions Doc/library/runpy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ The :mod:`!runpy` module provides two functions:

Execute the code at the named filesystem location and return the resulting
module's globals dictionary. As with a script name supplied to the CPython
command line, *file_path* may refer to a Python source file, a
command line, *path_name* may refer to a Python source file, a
compiled bytecode file or a valid :data:`sys.path` entry containing a
:mod:`__main__` module
(e.g. a zipfile containing a top-level :file:`__main__.py` file).
Expand Down Expand Up @@ -134,20 +134,20 @@ The :mod:`!runpy` module provides two functions:
``__name__`` is set to *run_name* if this optional argument is not
:const:`None` and to ``'<run_path>'`` otherwise.

If *file_path* directly references a script file (whether as source
If *path_name* directly references a script file (whether as source
or as precompiled byte code), then ``__file__`` will be set to
*file_path*, and ``__spec__``, ``__loader__`` and
*path_name*, and ``__spec__``, ``__loader__`` and
``__package__`` will all be set to :const:`None`.

If *file_path* is a reference to a valid :data:`sys.path` entry, then
If *path_name* is a reference to a valid :data:`sys.path` entry, then
``__spec__`` will be set appropriately for the imported :mod:`__main__`
module (that is, ``__spec__.name`` will always be ``__main__``).
``__file__``, ``__loader__`` and ``__package__`` will be
:ref:`set as normal <import-mod-attrs>` based on the module spec.

A number of alterations are also made to the :mod:`sys` module. Firstly,
:data:`sys.path` may be altered as described above. ``sys.argv[0]`` is updated
with the value of *file_path* and ``sys.modules[__name__]`` is updated
with the value of *path_name* and ``sys.modules[__name__]`` is updated
with a temporary module object for the module being executed. All
modifications to items in :mod:`sys` are reverted before the function
returns.
Expand Down
Loading