refactor: remove the short version flag

Author: leodevian

changelog.d/+fedb3a15.removed.md

@@ -0,0 +1 @@
+Remove the short version flag `-V` for all command-line interfaces.

template/src/{{ package_name }}/{% if cli == 'argparse' %}.{% endif %}/cli.py.jinja

@@ -22,7 +22,7 @@ def create_parser() -> argparse.ArgumentParser:
         description="run the main program",
     )
     parser.add_argument(
-        "--version", "-V", action="version", version="%(prog)s " + __version__
+        "--version", action="version", version=f"%(prog)s {__version__}"
     )
     return parser
 

template/src/{{ package_name }}/{% if cli == 'click' %}.{% endif %}/cli.py.jinja

@@ -9,7 +9,7 @@ from . import __version__
 
 @click.command()
 @click.help_option("--help", "-h")
-@click.version_option(__version__, "--version", "-V")
+@click.version_option()
 def main() -> None:
     """Run the main program."""
     return

template/src/{{ package_name }}/{% if cli == 'cyclopts' %}.{% endif %}/cli.py.jinja

@@ -9,7 +9,6 @@ from . import __version__
 app = cyclopts.App(
     help="Run the main program.",
     version=f"{{ distribution_name }}, version {__version__}",
-    version_flags=("--version", "-V"),
 )
 
 

template/src/{{ package_name }}/{% if cli == 'typer' %}.{% endif %}/cli.py.jinja

@@ -28,7 +28,6 @@ def main(
         bool,
         typer.Option(
             "--version",
-            "-V",
             callback=show_version,
             is_eager=True,
             help="Show the version and exit.",

template/tests/{% if cli == 'argparse' %}test_cli.py{% endif %}.jinja

@@ -22,11 +22,10 @@ def test_show_help(option: str) -> None:
     assert excinfo.value.code == 0
 
 
-@pytest.mark.parametrize("option", ["--version", "-V"])
-def test_show_version(option: str, capsys: pytest.CaptureFixture[str]) -> None:
+def test_show_version(capsys: pytest.CaptureFixture[str]) -> None:
     """Test the version option of the command-line interface."""
     with pytest.raises(SystemExit) as excinfo:
-        main([option])
+        main(["--version"])
 
     assert excinfo.value.code == 0
 

template/tests/{% if cli == 'click' %}test_cli.py{% endif %}.jinja

@@ -24,10 +24,9 @@ def test_show_help(option: str) -> None:
     assert result.exit_code == 0
 
 
-@pytest.mark.parametrize("option", ["--version", "-V"])
-def test_show_version(option: str) -> None:
+def test_show_version() -> None:
     """Test the version option of the command-line interface."""
     runner = CliRunner()
-    result = runner.invoke(main, [option])
+    result = runner.invoke(main, ["--version"])
     assert result.exit_code == 0
     assert __version__ in result.stdout

template/tests/{% if cli == 'cyclopts' %}test_cli.py{% endif %}.jinja

@@ -21,10 +21,9 @@ def test_show_help(option: str) -> None:
     assert result is None
 
 
-@pytest.mark.parametrize("option", ["--version", "-V"])
-def test_show_version(option: str, capsys: pytest.CaptureFixture[str]) -> None:
+def test_show_version(capsys: pytest.CaptureFixture[str]) -> None:
     """Test the version option of the command-line interface."""
-    result = app([option])
+    result = app(["--version"])
     assert result is None
 
     captured = capsys.readouterr()

template/tests/{% if cli == 'typer' %}test_cli.py{% endif %}.jinja

@@ -24,10 +24,9 @@ def test_show_help(option: str) -> None:
     assert result.exit_code == 0
 
 
-@pytest.mark.parametrize("option", ["--version", "-V"])
-def test_show_version(option: str) -> None:
+def test_show_version() -> None:
     """Test the version option of the command-line interface."""
     runner = CliRunner()
-    result = runner.invoke(app, [option])
+    result = runner.invoke(app, ["--version"])
     assert result.exit_code == 0
     assert __version__ in result.stdout