Skip to content

SCANPY-168 Limit size of output on wrong argument #217

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
maksim-grebeniuk-sonarsource merged 1 commit into from
Jun 13, 2025
Merged

SCANPY-168 Limit size of output on wrong argument #217

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
9 changes: 9 additions & 0 deletions src/pysonar_scanner/configuration/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@
from pysonar_scanner.exceptions import UnexpectedCliArgument


class PyScannerHelpFormatter(argparse.HelpFormatter):
recommended_args = {"help", "token", "sonar_project_key"}
Copy link
Copy Markdown
Contributor

@thomas-serre-sonarsource thomas-serre-sonarsource Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit It is minimal or mandatory args, not recommended args in my opinion

Suggested change
recommended_args = {"help", "token", "sonar_project_key"}
mandatory_args = {"help", "token", "sonar_project_key"}

Copy link
Copy Markdown
Contributor Author

@maksim-grebeniuk-sonarsource maksim-grebeniuk-sonarsource Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically they are not mandatory, as I understand it will work for instance if them will be specified in toml file or env variable


def _format_actions_usage(self, actions, groups):
filtered_actions = [action for action in actions if action.dest in PyScannerHelpFormatter.recommended_args]
return super()._format_actions_usage(filtered_actions, groups)


class CliConfigurationLoader:

@classmethod
Expand Down Expand Up @@ -59,6 +67,7 @@ def __create_parser(cls):
parser = argparse.ArgumentParser(
description="Sonar scanner CLI for Python",
epilog="Analysis properties not listed here will also be accepted, as long as they start with the -D prefix.",
formatter_class=PyScannerHelpFormatter,
)

parser.add_argument(
Expand Down