Clarifications to the command-line tools guide#2061
Open
anpol wants to merge 3 commits into
Open
Conversation
When describing a CLI command with `typer`, it might be more common to use unqualified names, especially when you are defining many command parameters and want to avoid repetitive typing.
anpol
changed the title
The intent of `greetings.cli` is likely to preconfigure the `app` object, exportable for reuse by others. Allowing `greetings.cli` to be runnable as a module didn't make much sense, because the `greetings` module itself is already runnable. Exporting the `main()` function and referencing it from the `pyproject.toml` is likely more common and concise than relying on the fact that the `app` object itself is callable.
anpol
force-pushed
the
cli-tools-guide-clarify
branch
from
28d9150 to
2fba17b
Compare
Importing the `main()` function is likely more common and concise than relying on the heavy-weight `app` object to be callable.
anpol
force-pushed
the
cli-tools-guide-clarify
branch
from
2fba17b to
00978cc
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The original command-line tools tutorial mixed together three separate execution-related concepts:
appobject, which defines the Typer-based CLI interface;if __name__ == "__main__"execution guard, typically used for direct module execution;__main__.pypackage entry point, used bypython -m greetings;This PR cleanly separates these responsibilities by:
cli.py,main()entry function,__main__.pyto a thin package launcher.This is the series of commits, please review them in order.
📚 Documentation preview 📚: https://python-packaging-user-guide--2061.org.readthedocs.build/en/2061/