Merge pull request #291 from callowayproject/287-return-scm-info-to-show

Fix: Return SCM information in show command

bumpversion/scm/git.py

@@ -27,6 +27,14 @@ def __init__(self, config: SCMConfig):
         self.config = config
         self._latest_tag_info: Optional[LatestTagInfo] = None
 
+    def __repr__(self) -> str:
+        """Return a string representation of the SCMTool."""
+        return self.__str__()
+
+    def __str__(self) -> str:
+        """A string representation of the object."""
+        return "Git"
+
     def is_available(self) -> bool:
         """Is the VCS implementation usable?"""
         try:

bumpversion/scm/hg.py

@@ -23,6 +23,14 @@ def __init__(self, config: SCMConfig):
         self.config = config
         self._latest_tag_info: Optional[LatestTagInfo] = None
 
+    def __repr__(self) -> str:
+        """Return a string representation of the SCMTool."""
+        return self.__str__()
+
+    def __str__(self) -> str:
+        """A string representation of the object."""
+        return "Mercurial"
+
     def is_available(self) -> bool:
         """Is the VCS implementation usable?"""
         try:

bumpversion/scm/models.py

@@ -110,6 +110,14 @@ class DefaultSCMTool:
     def __init__(self, config: SCMConfig):
         self.config = config
 
+    def __repr__(self) -> str:
+        """Return a string representation of the SCMTool."""
+        return self.__str__()
+
+    def __str__(self) -> str:
+        """A string representation of the object."""
+        return "None"
+
     def is_available(self) -> bool:
         """Return whether the SCM tool is available."""
         return True
@@ -151,6 +159,15 @@ def __init__(self, config: SCMConfig):
         self.tool: SCMTool = DefaultSCMTool(config)
         self._set_from_scm_tool()
 
+    def __repr__(self) -> str:
+        """Return a string representation of the SCMInfo."""
+        import pprint
+        from io import StringIO
+
+        str_io = StringIO()
+        pprint.pprint(self.as_dict(), stream=str_io)
+        return str_io.getvalue().rstrip()
+
     def as_dict(self) -> dict[str, Any]:
         """Return the information as a dict."""
         return {

bumpversion/show.py

@@ -4,12 +4,13 @@
 from io import StringIO
 from pathlib import Path
 from pprint import pprint
-from typing import Any, Optional
+from typing import Any, Optional, Union
 
 from bumpversion.bump import get_next_version
 from bumpversion.config import Config
 from bumpversion.context import get_context
 from bumpversion.exceptions import BadInputError
+from bumpversion.scm.models import SCMInfo
 from bumpversion.ui import print_error, print_info
 from bumpversion.utils import recursive_sort_dict
 
@@ -35,14 +36,16 @@ def output_json(value: dict) -> None:
     """Output the value as json."""
     import json
 
-    def default_encoder(obj: Any) -> str:
+    def default_encoder(obj: Any) -> Union[str, dict]:
         if dataclasses.is_dataclass(obj):
             return str(obj)
         elif isinstance(obj, type):
             return obj.__name__
         elif isinstance(obj, Path):
             return str(obj)
-        raise TypeError(f"Object of type {type(obj), str(obj)} is not JSON serializable")
+        elif isinstance(obj, SCMInfo):
+            return obj.as_dict()
+        return str(obj)
 
     print_info(json.dumps(value, sort_keys=True, indent=2, default=default_encoder))
 
@@ -124,7 +127,7 @@ def do_show(
     """Show current version or configuration information."""
     if current_version:
         config.current_version = current_version
-    config_dict = config.model_dump(exclude={"scm_info"})
+    config_dict = config.model_dump()
     ctx = get_context(config)
 
     if increment:

bumpversion/yaml_dump.py

@@ -6,6 +6,8 @@
 from textwrap import indent
 from typing import Any, Callable, Union
 
+from bumpversion.scm.models import SCMInfo
+
 DumperFunc = Callable[[Any], str]
 
 
@@ -90,7 +92,7 @@ def format_dict(val: dict) -> str:
 
     for key, value in sorted(val.items()):
         rendered_value = dump(value).strip()
-        if isinstance(value, (dict, list, tuple)):
+        if isinstance(value, (dict, list, tuple, SCMInfo)):
             rendered_value = f"\n{indent(rendered_value, INDENT)}"
         else:
             rendered_value = f" {rendered_value}"
@@ -146,3 +148,11 @@ def format_datetime(val: datetime.datetime) -> str:
 
 
 YAML_DUMPERS.add_dumper(datetime.datetime, format_datetime)
+
+
+def format_scminfo(val: SCMInfo) -> str:
+    """Return a string representation of a value."""
+    return format_dict(val.as_dict())
+
+
+YAML_DUMPERS.add_dumper(SCMInfo, format_scminfo)

tests/fixtures/basic_cfg_expected.txt

@@ -83,6 +83,15 @@
  'pre_commit_hooks': [],
  'regex': False,
  'replace': '{new_version}',
+ 'scm_info': {'branch_name': None,
+ 'commit_sha': None,
+ 'current_tag': None,
+ 'current_version': None,
+ 'dirty': None,
+ 'distance_to_latest_tag': 0,
+ 'repository_root': None,
+ 'short_branch_name': None,
+ 'tool': None},
  'search': '{current_version}',
  'serialize': ('{major}.{minor}.{patch}-{release}', '{major}.{minor}.{patch}'),
  'setup_hooks': [],

tests/fixtures/basic_cfg_expected.yaml

@@ -114,6 +114,16 @@ pre_commit_hooks:
 
 regex: false
 replace: "{new_version}"
+scm_info:
+  branch_name: null
+  commit_sha: null
+  current_tag: null
+  current_version: null
+  dirty: null
+  distance_to_latest_tag: 0
+  repository_root: null
+  short_branch_name: null
+  tool: "None"
 search: "{current_version}"
 serialize:
   - "{major}.{minor}.{patch}-{release}"

tests/fixtures/basic_cfg_expected_full.json

@@ -126,6 +126,17 @@
   "pre_commit_hooks": [],
   "regex": false,
   "replace": "{new_version}",
+  "scm_info": {
+    "branch_name": null,
+    "commit_sha": null,
+    "current_tag": null,
+    "current_version": null,
+    "dirty": null,
+    "distance_to_latest_tag": 0,
+    "repository_root": null,
+    "short_branch_name": null,
+    "tool": "None"
+  },
   "search": "{current_version}",
   "serialize": [
     "{major}.{minor}.{patch}-{release}",