GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing github.com — commitizen/commitizen/cli.py at master · commitizen-tools/commitizen Expand file tree/ Copy pathcli.pyMore file actions 731 lines (695 loc) · 29.1 KB / Copy pathcli.pyFile metadata and controls731 lines (695 loc) · 29.1 KB 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 from __future__ import annotations import argparse import logging import sys from copy import deepcopy from functools import partial from pathlib import Path from types import TracebackType from typing import TYPE_CHECKING, cast import argcomplete from decli import cli from commitizen import commands, config, out, version_schemes from commitizen.defaults import DEFAULT_SETTINGS from commitizen.exceptions import ( CommitizenException, ExitCode, ExpectedExit, InvalidCommandArgumentError, NoCommandFoundError, ) from commitizen.version_increment import VersionIncrement logger = logging.getLogger(__name__) class ParseKwargs(argparse.Action): """ Parse arguments in the for `key=value`. Quoted strings are automatically unquoted. Can be submitted multiple times: ex: -k key=value -k double-quotes="value" -k single-quotes='value' will result in namespace["opt"] == { "key": "value", "double-quotes": "value", "single-quotes": "value", } """ def __call__( self, parser: argparse.ArgumentParser, namespace: argparse.Namespace, values: object, option_string: str | None = None, ) -> None: if not isinstance(values, str): return key, sep, value = values.partition("=") if not key or not sep: raise InvalidCommandArgumentError( f"Option {option_string} expect a key=value format" ) kwargs = getattr(namespace, self.dest, None) or {} kwargs[key] = value.strip("'\"") setattr(namespace, self.dest, kwargs) tpl_arguments = ( { "name": ["--template", "-t"], "help": ( "Changelog template file name (relative to the current working directory)." ), }, { "name": ["--extra", "-e"], "action": ParseKwargs, "dest": "extras", "metavar": "EXTRA", "help": "Changelog extra variables (in the form 'key=value').", }, ) data = { "prog": "cz", "description": ( "Commitizen is a powerful release management tool that helps teams maintain consistent and meaningful commit messages while automating version management.\n" "For more information, please visit https://commitizen-tools.github.io/commitizen" ), "formatter_class": argparse.RawDescriptionHelpFormatter, "arguments": [ { "name": "--config", "help": "The path to the configuration file.", }, {"name": "--debug", "action": "store_true", "help": "Use debug mode."}, { "name": ["-n", "--name"], "help": "Use the given commitizen (default: cz_conventional_commits).", }, { "name": ["-nr", "--no-raise"], "type": str, "required": False, "help": "Comma-separated error codes that won't raise error, e.g., cz -nr 1,2,3 bump. See codes at https://commitizen-tools.github.io/commitizen/exit_codes/", }, ], "subcommands": { "title": "commands", "required": True, "commands": [ { "name": ["init"], "description": "Initialize commitizen configuration", "help": "Initialize commitizen configuration.", "func": commands.Init, }, { "name": ["commit", "c"], "description": "Create new commit", "help": "Create new commit.", "func": commands.Commit, "arguments": [ { "name": ["--retry"], "action": "store_true", "help": "Retry the last commit.", }, { "name": ["--no-retry"], "action": "store_true", "default": False, "help": "Skip retry if --retry or `retry_after_failure` is set to true.", }, { "name": "--dry-run", "action": "store_true", "help": "Perform a dry run, without committing or modifying files.", }, { "name": "--write-message-to-file", "type": Path, "metavar": "FILE_PATH", "help": "Write message to FILE_PATH before committing (can be used with --dry-run).", }, { "name": ["-s", "--signoff"], "action": "store_true", "help": "Deprecated, use `cz commit -- -s` instead.", }, { "name": ["-a", "--all"], "action": "store_true", # The help text aligns with the description of git commit --all "help": "Automatically stage files that have been modified and deleted, but new files you have not told Git about are not affected.", }, { "name": ["-e", "--edit"], "action": "store_true", "default": False, "help": "Edit the commit message before committing.", }, { "name": ["-l", "--message-length-limit"], "type": int, "help": "Set the length limit of the commit message; 0 for no limit.", }, { "name": ["--body-length-limit"], "type": int, "help": "Set the length limit of the commit body. Commit message in body will be rewrapped to this length; 0 for no limit.", }, { "name": ["--"], "action": "store_true", "dest": "double_dash", "help": "Positional arguments separator (recommended).", }, ], }, { "name": "ls", "description": "Show available Commitizens", "help": "Show available Commitizens.", "func": commands.ListCz, }, { "name": "example", "description": "Show commit example", "help": "Show commit example.", "func": commands.Example, }, { "name": "info", "description": "Show information about the cz", "help": "Show information about the cz.", "func": commands.Info, }, { "name": "schema", "description": "Show commit schema", "help": "Show commit schema.", "func": commands.Schema, }, { "name": "bump", "description": "Bump semantic version based on the git log", "help": "Bump semantic version based on the git log.", "func": commands.Bump, "arguments": [ { "name": "--dry-run", "action": "store_true", "help": "Perform a dry run, without committing or modifying files.", }, { "name": "--files-only", # TODO: rename to --version-files-only "action": "store_true", "help": "Bump version in the `version_files` specified in the configuration file only(deprecated; use --version-files-only instead).", }, { "name": "--version-files-only", "action": "store_true", "help": "Bump version in the files from the config", }, { "name": "--local-version", "action": "store_true", "help": "Bump version only the local version portion (ignoring the public version).", }, { "name": ["--changelog", "-ch"], "action": "store_true", "default": False, "help": "Generate the changelog for the latest version.", }, { "name": ["--no-verify"], "action": "store_true", "default": False, # The help text aligns with the description of git commit --no-verify "help": "Bypass the pre-commit and commit-msg hooks.", }, { "name": "--yes", "action": "store_true", "help": "Accept automatically answered questions.", }, { "name": "--tag-format", "help": ( "The format used to tag the commit and read it. " "Use it in existing projects, and wrap around simple quotes." ), }, { "name": "--bump-message", "help": ( "Template used to create the release commit, useful when working with CI." ), }, { "name": ["--prerelease", "-pr"], "help": "Type of prerelease.", "choices": ["alpha", "beta", "rc"], }, { "name": ["--devrelease", "-d"], "help": "Specify non-negative integer for dev release.", "type": int, }, { "name": ["--increment"], "help": "Specify the desired increment.", "choices": ["MAJOR", "MINOR", "PATCH"], "type": str.upper, }, { "name": ["--increment-mode"], "choices": ["linear", "exact"], "default": "linear", "help": ( "Set the method by which the new version is chosen. " "'linear' (default) resolves the next version based on typical linear version progression, " "where bumping of a pre-release with lower precedence than the current pre-release " "phase maintains the current phase of higher precedence. " "'exact' applies the changes that have been specified (or determined from the commit log) " "without interpretation, ensuring the increment and pre-release are always honored." ), }, { "name": ["--check-consistency", "-cc"], "help": ( "Check consistency among versions defined in Commitizen configuration file and `version_files`." ), "action": "store_true", }, { "name": ["--annotated-tag", "-at"], "help": "Create annotated tag instead of lightweight one.", "action": "store_true", }, { "name": ["--annotated-tag-message", "-atm"], "help": "Create annotated tag message.", "type": str, }, { "name": ["--gpg-sign", "-s"], "help": "Sign tag instead of lightweight one.", "default": False, "action": "store_true", }, { "name": ["--changelog-to-stdout"], "action": "store_true", "default": False, "help": "Output changelog to stdout.", }, { "name": ["--git-output-to-stderr"], "action": "store_true", "default": False, "help": "Redirect git output to stderr.", }, { "name": ["--retry"], "action": "store_true", "default": False, "help": "Retry commit if it fails for the first time.", }, { "name": ["--major-version-zero"], "action": "store_true", "default": None, "help": "Keep major version at zero, even for breaking changes.", }, *deepcopy(tpl_arguments), { "name": "--file-name", "help": "File name of changelog (default: 'CHANGELOG.md').", }, { "name": ["--prerelease-offset"], "type": int, "default": None, "help": "Start pre-releases with this offset.", }, { "name": ["--version-scheme"], "help": "Choose version scheme.", "default": None, "choices": version_schemes.KNOWN_SCHEMES, }, { "name": ["--version-type"], "help": "Deprecated, use `--version-scheme` instead.", "default": None, "choices": version_schemes.KNOWN_SCHEMES, }, { "name": "manual_version", "type": str, "nargs": "?", "help": "Bump to the given version (e.g., 1.5.3).", "metavar": "MANUAL_VERSION", }, { "name": ["--build-metadata"], "help": "Add additional build-metadata to the version-number.", "default": None, }, { "name": ["--get-next"], "action": "store_true", "help": "Determine the next version and write to stdout.", "default": False, }, { "name": ["--allow-no-commit"], "default": False, "help": "Bump version without eligible commits.", "action": "store_true", }, ], }, { "name": ["changelog", "ch"], "description": ( "Generate changelog (note that it will overwrite existing files)" ), "help": ( "Generate changelog (note that it will overwrite existing files)." ), "func": commands.Changelog, "arguments": [ { "name": "--dry-run", "action": "store_true", "default": False, "help": "Show changelog to stdout.", }, { "name": "--file-name", "help": "File name of changelog (default: 'CHANGELOG.md').", }, { "name": "--unreleased-version", "help": ( "Set the value for the new version (use the tag value), " "instead of using unreleased versions." ), }, { "name": "--incremental", "action": "store_true", "default": False, "help": ( "Generate changelog from the last created version, " "useful if the changelog has been manually modified." ), }, { "name": "rev_range", "type": str, "nargs": "?", "help": "Generate changelog for the given version (e.g., 1.5.3) or version range (e.g., 1.5.3..1.7.9).", }, { "name": "--start-rev", "default": None, "help": ( "Start rev of the changelog. " "If not set, it will generate changelog from the beginning." ), }, { "name": "--merge-prerelease", "action": "store_true", "default": False, "help": ( "Collect all changes from prereleases into the next non-prerelease. " "If not set, it will include prereleases in the changelog." ), }, { "name": ["--version-scheme"], "help": "Choose version scheme.", "default": None, "choices": version_schemes.KNOWN_SCHEMES, }, { "name": "--export-template", "default": None, "help": "Export the changelog template into this file instead of rendering it.", }, *deepcopy(tpl_arguments), { "name": "--tag-format", "help": "The format of the tag, wrap around simple quotes.", }, ], }, { "name": ["check"], "description": "Validate that a commit message matches the commitizen schema", "help": "Validate that a commit message matches the commitizen schema.", "func": commands.Check, "arguments": [ { "name": "--commit-msg-file", "help": ( "Ask for the name of the temporary file that contains the commit message. " "Use it in a git hook script: MSG_FILE=$1." ), "exclusive_group": "group1", }, { "name": "--rev-range", "help": "Validate the commits in the given range of git rev, e.g., master..HEAD.", "exclusive_group": "group1", }, { "name": ["-d", "--use-default-range"], "action": "store_true", "default": False, "help": "Validate the commits from the default branch to HEAD, e.g., refs/remotes/origin/master..HEAD.", "exclusive_group": "group1", }, { "name": ["-m", "--message"], "help": "Validate the given commit message.", "exclusive_group": "group1", }, { "name": ["--allow-abort"], "action": "store_true", "default": False, "help": "Allow empty commit messages, which typically abort a commit.", }, { "name": ["--allowed-prefixes"], "nargs": "*", "help": "Skip validation for commit messages that start with the specified prefixes.", }, { "name": ["-l", "--message-length-limit"], "type": int, "help": "Restrict the length of the **first line** of the commit message; 0 for no limit.", }, ], }, { "name": ["version"], "description": ( "Get the version of the installed commitizen or the current project (default: installed commitizen)" ), "help": ( "Get the version of the installed commitizen or the current project (default: installed commitizen)." ), "func": commands.Version, "arguments": [ { "name": ["-r", "--report"], "help": "Output the system information for reporting bugs.", "action": "store_true", "exclusive_group": "group1", }, { "name": ["-p", "--project"], "help": "Output the version of the current project.", "action": "store_true", "exclusive_group": "group1", }, { "name": ["-c", "--commitizen"], "help": "Output the version of the installed commitizen.", "action": "store_true", "exclusive_group": "group1", }, { "name": ["-v", "--verbose"], "help": ( "Output the version of both the installed commitizen and the current project." ), "action": "store_true", "exclusive_group": "group1", }, { "name": ["--major"], "help": ( "Output just the major version. Must be used with MANUAL_VERSION, " "--project, or --verbose." ), "action": "store_true", "exclusive_group": "group2", }, { "name": ["--minor"], "help": ( "Output just the minor version. Must be used with MANUAL_VERSION, " "--project, or --verbose." ), "action": "store_true", "exclusive_group": "group2", }, { "name": ["--tag"], "help": "get the version with tag prefix. Need to be used with --project or --verbose.", "action": "store_true", "exclusive_group": "group2", }, { "name": ["--patch"], "help": ( "Output the patch version only. Must be used with MANUAL_VERSION, " "--project, or --verbose." ), "action": "store_true", "exclusive_group": "group2", }, { "name": ["--next"], "help": "Output the next version.", "type": str, "nargs": "?", "default": None, "const": "USE_GIT_COMMITS", "choices": ["USE_GIT_COMMITS"] + [str(increment) for increment in VersionIncrement], }, { "name": "manual_version", "type": str, "nargs": "?", "help": "Use the version provided instead of the version from the project. Can be used to test the selected version scheme.", "metavar": "MANUAL_VERSION", }, ], }, ], }, } def commitizen_excepthook( exctype: type[BaseException], value: BaseException, traceback: TracebackType | None, debug: bool = False, no_raise: list[int] | None = None, ) -> None: traceback = traceback if isinstance(traceback, TracebackType) else None if not isinstance(value, CommitizenException): sys.__excepthook__(exctype, value, traceback) return if value.message: value.output_method(value.message) if debug: sys.__excepthook__(exctype, value, traceback) exit_code = value.exit_code if no_raise is not None and exit_code in no_raise: sys.exit(ExitCode.EXPECTED_EXIT) sys.exit(exit_code) def parse_no_raise(comma_separated_no_raise: str) -> list[int]: """Convert the given string to exit codes. Receives digits and strings and outputs the parsed integer which represents the exit code found in exceptions. """ def exit_code_from_str_or_skip(s: str) -> ExitCode | None: try: return ExitCode.from_str(s) except (KeyError, ValueError): out.warn(f"WARN: no_raise value `{s}` is not a valid exit code. Skipping.") return None return [ code.value for s in comma_separated_no_raise.split(",") if (code := exit_code_from_str_or_skip(s)) is not None ] if TYPE_CHECKING: class Args(argparse.Namespace): config: str | None = None debug: bool = False name: str | None = None no_raise: str | None = None # comma-separated string, later parsed as list[int] report: bool = False project: bool = False commitizen: bool = False verbose: bool = False func: type[ commands.Init # init | commands.Commit # commit (c) | commands.ListCz # ls | commands.Example # example | commands.Info # info | commands.Schema # schema | commands.Bump # bump | commands.Changelog # changelog (ch) | commands.Check # check | commands.Version # version ] def main() -> None: sys.excepthook = commitizen_excepthook parser: argparse.ArgumentParser = cli(data) argcomplete.autocomplete(parser) # Show help if no arg provided if len(sys.argv) == 1: parser.print_help(sys.stderr) raise ExpectedExit() # This is for the command required constraint in 2.0 try: args, unknown_args = parser.parse_known_args() except SystemExit as e: if e.code == 2: raise NoCommandFoundError() raise e arguments = vars(args) if unknown_args: # Raise error for extra-args without -- separation if "--" not in unknown_args: raise InvalidCommandArgumentError( f"Invalid commitizen arguments were found: `{' '.join(unknown_args)}`. " "Please use -- separator for extra git args" ) # Raise error for extra-args before -- elif unknown_args[0] != "--": pos = unknown_args.index("--") raise InvalidCommandArgumentError( f"Invalid commitizen arguments were found before -- separator: `{' '.join(unknown_args[:pos])}`. " ) # Log warning for -- without any extra args elif len(unknown_args) == 1: logger.warning( "\nWARN: Incomplete commit command: received -- separator without any following git arguments\n" ) extra_args = unknown_args[1:] arguments["extra_cli_args"] = extra_args conf = config.read_cfg(args.config) args = cast("Args", args) if args.name: conf.update({"name": args.name}) elif not conf.path: conf.update({"name": DEFAULT_SETTINGS["name"]}) if args.debug: logging.getLogger("commitizen").setLevel(logging.DEBUG) sys.excepthook = partial(sys.excepthook, debug=True) if args.no_raise: sys.excepthook = partial(sys.excepthook, no_raise=parse_no_raise(args.no_raise)) args.func(conf, arguments)() # type: ignore[arg-type] if __name__ == "__main__": main() |
| You are visitor 01402503 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |