| # SPDX-License-Identifier: GPL-2.0+ |
| # |
| # Copyright 2023 Google LLC |
| # |
| |
| """Handles parsing of buildman arguments |
| |
| This creates the argument parser and uses it to parse the arguments passed in |
| """ |
| |
| import argparse |
| import os |
| import pathlib |
| import sys |
| |
| from u_boot_pylib import gitutil |
| from patman import project |
| from patman import settings |
| |
| PATMAN_DIR = pathlib.Path(__file__).parent |
| HAS_TESTS = os.path.exists(PATMAN_DIR / "func_test.py") |
| |
| |
| class ErrorCatchingArgumentParser(argparse.ArgumentParser): |
| def __init__(self, **kwargs): |
| self.exit_state = None |
| self.catch_error = False |
| super().__init__(**kwargs) |
| |
| def error(self, message): |
| if self.catch_error: |
| self.message = message |
| else: |
| super().error(message) |
| |
| def exit(self, status=0, message=None): |
| if self.catch_error: |
| self.exit_state = True |
| else: |
| super().exit(status, message) |
| |
| |
| def add_send_args(par): |
| """Add arguments for the 'send' command |
| |
| Arguments: |
| par (ArgumentParser): Parser to add to |
| """ |
| par.add_argument( |
| '-c', '--count', dest='count', type=int, default=-1, |
| help='Automatically create patches from top n commits') |
| par.add_argument( |
| '-e', '--end', type=int, default=0, |
| help='Commits to skip at end of patch list') |
| par.add_argument( |
| '-i', '--ignore-errors', action='store_true', |
| dest='ignore_errors', default=False, |
| help='Send patches email even if patch errors are found') |
| par.add_argument( |
| '-l', '--limit-cc', dest='limit', type=int, default=None, |
| help='Limit the cc list to LIMIT entries [default: %(default)s]') |
| par.add_argument( |
| '-m', '--no-maintainers', action='store_false', |
| dest='add_maintainers', default=True, |
| help="Don't cc the file maintainers automatically") |
| default_arg = None |
| top_level = gitutil.get_top_level() |
| if top_level: |
| default_arg = os.path.join(top_level, 'scripts', |
| 'get_maintainer.pl') + ' --norolestats' |
| par.add_argument( |
| '--get-maintainer-script', dest='get_maintainer_script', type=str, |
| action='store', |
| default=default_arg, |
| help='File name of the get_maintainer.pl (or compatible) script.') |
| par.add_argument( |
| '-r', '--in-reply-to', type=str, action='store', |
| help="Message ID that this series is in reply to") |
| par.add_argument( |
| '-s', '--start', dest='start', type=int, default=0, |
| help='Commit to start creating patches from (0 = HEAD)') |
| par.add_argument( |
| '-t', '--ignore-bad-tags', action='store_true', default=False, |
| help='Ignore bad tags / aliases (default=warn)') |
| par.add_argument( |
| '--no-binary', action='store_true', dest='ignore_binary', |
| default=False, |
| help="Do not output contents of changes in binary files") |
| par.add_argument( |
| '--no-check', action='store_false', dest='check_patch', default=True, |
| help="Don't check for patch compliance") |
| par.add_argument( |
| '--tree', dest='check_patch_use_tree', default=False, |
| action='store_true', |
| help=("Set `tree` to True. If `tree` is False then we'll pass " |
| "'--no-tree' to checkpatch (default: tree=%(default)s)")) |
| par.add_argument( |
| '--no-tree', dest='check_patch_use_tree', action='store_false', |
| help="Set `tree` to False") |
| par.add_argument( |
| '--no-tags', action='store_false', dest='process_tags', default=True, |
| help="Don't process subject tags as aliases") |
| par.add_argument( |
| '--no-signoff', action='store_false', dest='add_signoff', |
| default=True, help="Don't add Signed-off-by to patches") |
| par.add_argument( |
| '--smtp-server', type=str, |
| help="Specify the SMTP server to 'git send-email'") |
| par.add_argument( |
| '--keep-change-id', action='store_true', |
| help='Preserve Change-Id tags in patches to send.') |
| |
| |
| def _add_show_comments(parser): |
| parser.add_argument('-c', '--show-comments', action='store_true', |
| help='Show comments from each patch') |
| |
| |
| def add_send_subparser(subparsers): |
| """Add the 'send' subparser |
| |
| Args: |
| subparsers (argparse action): Subparser parent |
| |
| Return: |
| ArgumentParser: send subparser |
| """ |
| send = subparsers.add_parser( |
| 'send', help='Format, check and email patches (default command)') |
| send.add_argument( |
| '-b', '--branch', type=str, |
| help="Branch to process (by default, the current branch)") |
| send.add_argument( |
| '-n', '--dry-run', action='store_true', dest='dry_run', |
| default=False, help="Do a dry run (create but don't email patches)") |
| send.add_argument( |
| '--cc-cmd', dest='cc_cmd', type=str, action='store', |
| default=None, help='Output cc list for patch file (used by git)') |
| add_send_args(send) |
| send.add_argument('patchfiles', nargs='*') |
| return send |
| |
| |
| def add_status_subparser(subparsers): |
| """Add the 'status' subparser |
| |
| Args: |
| subparsers (argparse action): Subparser parent |
| |
| Return: |
| ArgumentParser: status subparser |
| """ |
| status = subparsers.add_parser('status', |
| help='Check status of patches in patchwork') |
| _add_show_comments(status) |
| status.add_argument( |
| '-d', '--dest-branch', type=str, |
| help='Name of branch to create with collected responses') |
| status.add_argument('-f', '--force', action='store_true', |
| help='Force overwriting an existing branch') |
| status.add_argument('-T', '--single-thread', action='store_true', |
| help='Disable multithreading when reading patchwork') |
| return status |
| |
| |
| def setup_parser(): |
| """Set up command-line parser |
| |
| Returns: |
| argparse.Parser object |
| """ |
| epilog = '''Create patches from commits in a branch, check them and email |
| them as specified by tags you place in the commits. Use -n to do a dry |
| run first.''' |
| |
| parser = ErrorCatchingArgumentParser(epilog=epilog) |
| parser.add_argument( |
| '-D', '--debug', action='store_true', |
| help='Enabling debugging (provides a full traceback on error)') |
| parser.add_argument( |
| '-N', '--no-capture', action='store_true', |
| help='Disable capturing of console output in tests') |
| parser.add_argument('-p', '--project', default=project.detect_project(), |
| help="Project name; affects default option values and " |
| "aliases [default: %(default)s]") |
| parser.add_argument('-P', '--patchwork-url', |
| default='https://patchwork.ozlabs.org', |
| help='URL of patchwork server [default: %(default)s]') |
| parser.add_argument( |
| '-T', '--thread', action='store_true', dest='thread', |
| default=False, help='Create patches as a single thread') |
| parser.add_argument( |
| '-v', '--verbose', action='store_true', dest='verbose', default=False, |
| help='Verbose output of errors and warnings') |
| parser.add_argument( |
| '-X', '--test-preserve-dirs', action='store_true', |
| help='Preserve and display test-created directories') |
| parser.add_argument( |
| '-H', '--full-help', action='store_true', dest='full_help', |
| default=False, help='Display the README file') |
| |
| subparsers = parser.add_subparsers(dest='cmd') |
| add_send_subparser(subparsers) |
| add_status_subparser(subparsers) |
| |
| # Only add the 'test' action if the test data files are available. |
| if HAS_TESTS: |
| test_parser = subparsers.add_parser('test', help='Run tests') |
| test_parser.add_argument('testname', type=str, default=None, nargs='?', |
| help="Specify the test to run") |
| |
| return parser |
| |
| |
| def parse_args(argv=None, config_fname=None, parser=None): |
| """Parse command line arguments from sys.argv[] |
| |
| Args: |
| argv (str or None): Arguments to process, or None to use sys.argv[1:] |
| config_fname (str): Config file to read, or None for default, or False |
| for an empty config |
| |
| Returns: |
| tuple containing: |
| options: command line options |
| args: command lin arguments |
| """ |
| if not parser: |
| parser = setup_parser() |
| |
| # Parse options twice: first to get the project and second to handle |
| # defaults properly (which depends on project) |
| # Use parse_known_args() in case 'cmd' is omitted |
| if not argv: |
| argv = sys.argv[1:] |
| |
| args, rest = parser.parse_known_args(argv) |
| if hasattr(args, 'project'): |
| settings.Setup(parser, args.project, argv, config_fname) |
| args, rest = parser.parse_known_args(argv) |
| |
| # If we have a command, it is safe to parse all arguments |
| if args.cmd: |
| args = parser.parse_args(argv) |
| elif not args.full_help: |
| # No command, so insert it after the known arguments and before the ones |
| # that presumably relate to the 'send' subcommand |
| nargs = len(rest) |
| argv = argv[:-nargs] + ['send'] + rest |
| args = parser.parse_args(argv) |
| |
| return args |