Skip to content

Fixed write_usage producing empty output when args is empty. #3413

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

Closed
tejasae-afk wants to merge 1 commit into from
+10 −1
Closed

Fixed write_usage producing empty output when args is empty. #3413

Show file tree
Hide file tree
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
4 changes: 3 additions & 1 deletion src/click/formatting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,9 @@ def write_usage(self, prog: str, args: str = "", prefix: str | None = None) -> N
usage_prefix = f"{prefix:>{self.current_indent}}{prog} "
text_width = self.width - self.current_indent

if text_width >= (term_len(usage_prefix) + 20):
if not args:
self.write(usage_prefix.rstrip())
elif text_width >= (term_len(usage_prefix) + 20):
# The arguments will fit to the right of the prefix.
indent = " " * term_len(usage_prefix)
self.write(
Expand Down
7 changes: 7 additions & 0 deletions tests/test_formatting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,3 +433,10 @@ def test_help_formatter_write_text():
actual = formatter.getvalue()
expected = " Lorem ipsum dolor sit amet,\n consectetur adipiscing elit\n"
assert actual == expected


def test_help_formatter_write_usage_no_args():
"""write_usage with no args should still print the usage line."""
formatter = click.HelpFormatter()
formatter.write_usage("program")
assert formatter.getvalue() == "Usage: program\n"
Loading