test: update tests with less redundant output generated by argparse --help in Python 3.13

Author: jakob-keller

tests/commands/test_bump_command.py

@@ -30,7 +30,7 @@
     NotAllowed,
     NoVersionSpecifiedError,
 )
-from tests.utils import create_file_and_commit, create_tag, skip_below_py_3_10
+from tests.utils import create_file_and_commit, create_tag, skip_below_py_3_13
 
 
 @pytest.mark.parametrize(
@@ -1452,7 +1452,7 @@ def test_bump_changelog_contains_increment_only(mocker, tmp_commitizen_project,
     assert "2.0.0" not in out
 
 
-@skip_below_py_3_10
+@skip_below_py_3_13
 def test_bump_command_shows_description_when_use_help_option(
     mocker: MockFixture, capsys, file_regression
 ):

tests/commands/test_bump_command/test_bump_command_shows_description_when_use_help_option.txt

@@ -33,9 +33,9 @@ options:
   --bump-message BUMP_MESSAGE
                         template used to create the release commit, useful
                         when working with CI
-  --prerelease {alpha,beta,rc}, -pr {alpha,beta,rc}
+  --prerelease, -pr {alpha,beta,rc}
                         choose type of prerelease
-  --devrelease DEVRELEASE, -d DEVRELEASE
+  --devrelease, -d DEVRELEASE
                         specify non-negative integer for dev. release
   --increment {MAJOR,MINOR,PATCH}
                         manually specify the desired increment
@@ -53,7 +53,7 @@ options:
                         check consistency among versions defined in commitizen
                         configuration and version_files
   --annotated-tag, -at  create annotated tag instead of lightweight one
-  --annotated-tag-message ANNOTATED_TAG_MESSAGE, -atm ANNOTATED_TAG_MESSAGE
+  --annotated-tag-message, -atm ANNOTATED_TAG_MESSAGE
                         create annotated tag message
   --gpg-sign, -s        sign tag instead of lightweight one
   --changelog-to-stdout
@@ -62,11 +62,10 @@ options:
                         Redirect git output to stderr
   --retry               retry commit if it fails the 1st time
   --major-version-zero  keep major version at zero, even for breaking changes
-  --template TEMPLATE, -t TEMPLATE
+  --template, -t TEMPLATE
                         changelog template file name (relative to the current
                         working directory)
-  --extra EXTRA, -e EXTRA
-                        a changelog extra variable (in the form 'key=value')
+  --extra, -e EXTRA     a changelog extra variable (in the form 'key=value')
   --file-name FILE_NAME
                         file name of changelog (default: 'CHANGELOG.md')
   --prerelease-offset PRERELEASE_OFFSET

tests/commands/test_changelog_command.py

@@ -29,7 +29,7 @@
     create_tag,
     get_current_branch,
     merge_branch,
-    skip_below_py_3_10,
+    skip_below_py_3_13,
     switch_branch,
     wait_for_tag,
 )
@@ -1640,7 +1640,7 @@ def test_export_changelog_template_from_plugin(
     assert target.read_text() == tpl
 
 
-@skip_below_py_3_10
+@skip_below_py_3_13
 def test_changelog_command_shows_description_when_use_help_option(
     mocker: MockFixture, capsys, file_regression
 ):

tests/commands/test_changelog_command/test_changelog_command_shows_description_when_use_help_option.txt

@@ -33,8 +33,7 @@ options:
   --export-template EXPORT_TEMPLATE
                         Export the changelog template into this file instead
                         of rendering it
-  --template TEMPLATE, -t TEMPLATE
+  --template, -t TEMPLATE
                         changelog template file name (relative to the current
                         working directory)
-  --extra EXTRA, -e EXTRA
-                        a changelog extra variable (in the form 'key=value')
+  --extra, -e EXTRA     a changelog extra variable (in the form 'key=value')

tests/commands/test_check_command.py

@@ -12,7 +12,7 @@
     InvalidCommitMessageError,
     NoCommitsFoundError,
 )
-from tests.utils import create_file_and_commit, skip_below_py_3_10
+from tests.utils import create_file_and_commit, skip_below_py_3_13
 
 COMMIT_LOG = [
     "refactor: A code change that neither fixes a bug nor adds a feature",
@@ -416,7 +416,7 @@ def test_check_conventional_commit_succeed_with_git_diff(mocker, capsys):
     assert "Commit validation: successful!" in out
 
 
-@skip_below_py_3_10
+@skip_below_py_3_13
 def test_check_command_shows_description_when_use_help_option(
     mocker: MockFixture, capsys, file_regression
 ):

tests/commands/test_check_command/test_check_command_shows_description_when_use_help_option.txt

@@ -13,13 +13,13 @@ options:
                         MSG_FILE=$1
   --rev-range REV_RANGE
                         a range of git rev to check. e.g, master..HEAD
-  -m MESSAGE, --message MESSAGE
+  -m, --message MESSAGE
                         commit message that needs to be checked
   --allow-abort         allow empty commit messages, which typically abort a
                         commit
   --allowed-prefixes [ALLOWED_PREFIXES ...]
                         allowed commit message prefixes. If the message starts
                         by one of these prefixes, the message won't be checked
                         against the regex
-  -l MESSAGE_LENGTH_LIMIT, --message-length-limit MESSAGE_LENGTH_LIMIT
+  -l, --message-length-limit MESSAGE_LENGTH_LIMIT
                         length limit of the commit message; 0 for no limit

tests/commands/test_commit_command.py

@@ -19,7 +19,7 @@
     NotAllowed,
     NothingToCommitError,
 )
-from tests.utils import skip_below_py_3_10
+from tests.utils import skip_below_py_3_13
 
 
 @pytest.fixture
@@ -410,7 +410,7 @@ def test_commit_command_with_message_length_limit(config, mocker: MockFixture):
         commands.Commit(config, {"message_length_limit": message_length - 1})()
 
 
-@skip_below_py_3_10
+@skip_below_py_3_13
 def test_commit_command_shows_description_when_use_help_option(
     mocker: MockFixture, capsys, file_regression
 ):

tests/commands/test_commit_command/test_commit_command_shows_description_when_use_help_option.txt

@@ -16,5 +16,5 @@ options:
   -a, --all             Tell the command to automatically stage files that
                         have been modified and deleted, but new files you have
                         not told Git about are not affected.
-  -l MESSAGE_LENGTH_LIMIT, --message-length-limit MESSAGE_LENGTH_LIMIT
+  -l, --message-length-limit MESSAGE_LENGTH_LIMIT
                         length limit of the commit message; 0 for no limit

tests/utils.py

@@ -15,6 +15,11 @@
     reason="The output message of argparse is different between Python 3.10 and lower than Python 3.10",
 )
 
+skip_below_py_3_13 = pytest.mark.skipif(
+    sys.version_info < (3, 13),
+    reason="The output message of argparse is different between Python 3.13 and lower than Python 3.13",
+)
+
 
 class FakeCommand:
     def __init__(self, out=None, err=None, return_code=0):