Skip to content

bpo-39452: rewrite and expand __main__.rst #26883

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.

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 51 commits into from
Aug 24, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
02e9edf
__main__docs: intro and first secton
jdevries3133 Jun 21, 2021
c95f69b
bpo-44494: rewrite of Doc/library/__main__.rst (first draft)
jdevries3133 Jun 23, 2021
235e866
bpo-44494: add blurb
jdevries3133 Jun 23, 2021
a292ab6
Update __main__.rst
geryogam Jun 30, 2019
d7a1999
Update __main__.rst
geryogam Jun 30, 2019
8398f08
Take Steven d’Aprano’s review into account
geryogam Sep 16, 2020
1fcb2af
Rewrap lines
geryogam Sep 16, 2020
2bde063
Remove trailing whitespaces
geryogam Sep 17, 2020
d29fd2a
bpo-39452: rewrite and expansion of __main__.rst
jdevries3133 Jun 23, 2021
4c60f2c
mention runpy
jdevries3133 Jun 29, 2021
2b5f710
add "design patterns" section, fix section title hierarchies
jdevries3133 Jun 29, 2021
7e495d7
add sentence about console_scripts
jdevries3133 Jun 29, 2021
56afeaa
misc formatting; change "Design Patterns" to "Idiomatic Usage"
jdevries3133 Jun 30, 2021
2a398ef
add section about sys.exit(main()) convention
jdevries3133 Jun 30, 2021
1a9956c
make last paragraph 'idiomatic usage'; add comment about maybe deleting
jdevries3133 Jun 30, 2021
c4b5cea
fix linting error (default context used in comment)
jdevries3133 Jun 30, 2021
1f012b4
revise example so that main() does not take arguments
jdevries3133 Jun 30, 2021
f095362
add console_scripts section, remove bad old example
jdevries3133 Jun 30, 2021
c42b706
minor proofreading changes
jdevries3133 Jun 30, 2021
7fe7f1c
implement changes suggest by @merwok
jdevries3133 Jun 30, 2021
c063da1
fix: typos
jdevries3133 Jun 30, 2021
7c6b451
fix wording, slim down example, add reference to relative import docs
jdevries3133 Jul 7, 2021
06bcb09
respond to review from @pradyunsg
jdevries3133 Jul 21, 2021
80756b3
Merge remote-tracking branch 'upstream/main' into bpo-39452__main__docs
jdevries3133 Jul 31, 2021
647c471
add `import __main__` section
jdevries3133 Aug 1, 2021
457bbc9
revisions and proofreading
jdevries3133 Aug 1, 2021
3d9b3b9
eliminate opinionated section about idiomatic usage of `__main__.py`
jdevries3133 Aug 1, 2021
dd68513
proofread `__main__.py` section
jdevries3133 Aug 1, 2021
6ee7090
Merge branch 'main' of github.com:python/cpython into bpo-39452__main…
jdevries3133 Aug 4, 2021
757b03a
incorporate suggested changes from @Fidget-Spinner
jdevries3133 Aug 10, 2021
8e86468
incorporate suggested changes from @yaseppochi
jdevries3133 Aug 10, 2021
f33a081
fix formatting
jdevries3133 Aug 10, 2021
14bad85
name equals main
jdevries3133 Aug 12, 2021
d150674
Merge branch 'main' of github.com:python/cpython into bpo-39452__main…
jdevries3133 Aug 12, 2021
7b987cb
Merge branch 'bpo-39452__main__docs' of github.com:jdevries3133/cpyth…
jdevries3133 Aug 12, 2021
b9db705
also change reference to name equals main section
jdevries3133 Aug 12, 2021
168c774
implement feedback from @holdenweb, python-dev, and @merwork
jdevries3133 Aug 12, 2021
c450171
fix trailing whitespace
jdevries3133 Aug 12, 2021
077e7a4
Remove .bak file
ambv Aug 24, 2021
eb42489
Thorough editing pass
ambv Aug 24, 2021
7c61e78
Move `__main__.py` section above the `import __main__` section
ambv Aug 24, 2021
45a9425
s/command line/command-line/
ambv Aug 24, 2021
073e9d7
Mention asyncio.__main__
ambv Aug 24, 2021
ccb9004
Restore proper document name
ambv Aug 24, 2021
f8630fa
Use proper .. seealso:: sections.
ambv Aug 24, 2021
1e86e02
Appease `make suspicious`
ambv Aug 24, 2021
9c87442
Spell out examples of top-level code environments
ambv Aug 24, 2021
0d4fc8a
Appease double dot alignment aesthetics
ambv Aug 24, 2021
4e51333
Replace lies with truth
ambv Aug 24, 2021
6f0f82c
Improve flow introducing what "top-level code environment" is
ambv Aug 24, 2021
46e7668
Use module names consistently in example
ambv Aug 24, 2021
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
17 changes: 12 additions & 5 deletions Doc/library/__main__.rst
Original file line number Diff line number Diff line change
Expand Up @@ -329,11 +329,18 @@ status code 0, indicating success:

Note that importing ``__main__`` doesn't cause any issues with unintentionally
running top-level code meant for script use which is put in the
``if __name__ == "__main__"`` block of ``start.py``. It's because this code
has already executed at the start of the program and the module is already
fully loaded when ``namely.py`` imports ``__main__``.

The Python REPL is one example of a "top-level environment", so anything
``if __name__ == "__main__"`` block of ``start.py``. Why does this work?

Python inserts an empty ``__main__`` module in :attr:`sys.modules` at
interpreter startup, and populates it by running top-level code. In our example
this is the ``start.py`` file which runs line by line and imports ``namely``.
In turn, ``namely.py`` imports ``__main__`` (which is ``start.py``). That's an
import cycle! Fortunately, since the partially populated ``__main__``
module is present in :attr:`sys.modules`, Python passes that to ``namely.py``.
See :ref:`Special considerations for __main__ <import-dunder-main>` in the
import system's reference for details on how this works.

The Python REPL is another example of a "top-level environment", so anything
defined in the REPL becomes part of the ``__main__`` scope::

>>> import namely
Expand Down
2 changes: 2 additions & 0 deletions Doc/reference/import.rst
Original file line number Diff line number Diff line change
Expand Up @@ -975,6 +975,8 @@ should expose ``XXX.YYY.ZZZ`` as a usable expression, but .moduleY is
not a valid expression.


.. _import-dunder-main:

Special considerations for __main__
===================================

Expand Down