v66 Added support for specifying the program version

Author: overgodofchaos

pydantic_argparse_next/parser/classes.py

@@ -83,6 +83,7 @@ class ParserConfig(BaseModel):
     program_name: str | None = None
     description: str | None = None
     epilog: str | None = None
+    version: str | None = None
     subcommand_required: bool = True
     # subcommand_destination: str = "subcommand"
 
@@ -110,10 +111,11 @@ def parserconfig(
         program_name: str = None,
         description: str = None,
         epilog: str = None,
-        subcommand_required: bool = True
+        subcommand_required: bool = True,
+        version: str = None
 ):
     return ParserConfig(program_name=program_name, description=description, epilog=epilog,
-                        subcommand_required=subcommand_required)
+                        subcommand_required=subcommand_required, version=version)
 
 
 class PydanticArgparserError(Exception):

pydantic_argparse_next/parser/parse.py

@@ -19,6 +19,7 @@ def parse(
         description: str = None,
         epilog: str = None,
         subcomand_required: bool = True,
+        version: str = None,
         args: list[str] = None
 ) -> T:
     if args is None:
@@ -33,7 +34,7 @@ def parse(
         args_ = args
 
     parser = Parser(model=model, args=args_)
-    if any([program_name, description, epilog]):
+    if any([program_name, description, epilog, version]):
         if hasattr(model, "__parserconfig__"):
             if not isinstance(model.__parserconfig__, ParserConfig):
                 model.__parserconfig__ = ParserConfig()
@@ -48,6 +49,8 @@ def parse(
             model.__parserconfig__.epilog = epilog
         if subcomand_required is False:
             model.__parserconfig__.subcommand_required = subcomand_required
+        if version:
+            model.__parserconfig__.version = version
 
     args_model = parser.resolve()
 

pydantic_argparse_next/parser/parser.py

@@ -106,6 +106,10 @@ def program_description(self) -> str | None:
     def program_epilog(self) -> str | None:
         return self._parserconfig.epilog
 
+    @property
+    def program_version(self) -> str | None:
+        return self._parserconfig.version
+
     # @property
     # def subcommand_destionation(self) -> str:
     #     name = self._parserconfig.subcommand_destination
@@ -198,16 +202,20 @@ def show_help(self):
         console = Console()
 
         # Program name and description
+        name = self.name
+        if self.program_version and not self.is_subcommand:
+            name += f" {self.program_version}"
+
         if self.program_description:
             program = Panel(
                 self.program_description,
                 title_align="left",
-                title=self.name,
+                title=name,
                 border_style="bold yellow"
             )
         else:
             program = Panel(
-                self.name,
+                name,
                 title_align="left",
                 title=None,
                 border_style="bold yellow"

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "pydantic-argparse-next"
-version = "1.0.3"
+version = "1.0.4"
 description = "Pydantic 2 argparse."
 readme = "README.md"
 requires-python = ">=3.11"

tests/help/test_help.py

@@ -49,6 +49,7 @@ class Test(BaseModel):
             program_name="Test program name",
             description="Test program description",
             epilog="Test program epilog",
+            version="1.0.5"
         )
 
         a: str = pa.KwArg(..., description="test")
@@ -59,6 +60,30 @@ class Test(BaseModel):
     assert "Test program name" in output
     assert "Test program description" in output
     assert "Test program epilog" in output
+    assert "1.0.5" in output
+
+
+def test_parserconfig_2(capsys):
+    class Test(BaseModel):
+        a: str = pa.KwArg(..., description="test")
+        b: str = pa.KwArg(None, description="test")
+
+    with patch("sys.exit") as mocked_exit:
+        result = pa.parse(
+            Test,
+            args=["--help"],
+            program_name="Test program name",
+            description="Test program description",
+            epilog="Test program epilog",
+            version="1.0.5"
+        )
+
+    output = capsys.readouterr().out
+
+    assert "Test program name" in output
+    assert "Test program description" in output
+    assert "Test program epilog" in output
+    assert "1.0.5" in output
 
 
 def test_help_subcomands(capsys):