Fixed logging output and output in general.

Author: coordt

bumpversion/bump.py

@@ -70,10 +70,12 @@ def do_bump(
     next_version_str = config.version_config.serialize(next_version, ctx)
     logger.info("New version will be '%s'", next_version_str)
 
+    if dry_run:
+        logger.info("Dry run active, won't touch any files.")
+
     ctx = get_context(config, version, next_version)
 
     configured_files = resolve_file_config(config.files, config.version_config)
-
     modify_files(configured_files, version, next_version, ctx, dry_run)
 
     update_config_file(config_file, config.current_version, next_version_str, dry_run)

bumpversion/cli.py

@@ -160,6 +160,8 @@ def bump(
     """Change the version."""
     setup_logging(verbose)
 
+    logger.info("Starting BumpVersion %s", __version__)
+
     overrides = get_overrides(
         allow_dirty=allow_dirty,
         current_version=current_version,
@@ -175,6 +177,7 @@ def bump(
         message=message,
         commit_args=commit_args,
     )
+
     found_config_file = find_config_file(config_file)
     config = get_configuration(found_config_file, **overrides)
 

bumpversion/config.py

@@ -4,6 +4,7 @@
 import itertools
 import logging
 import re
+from difflib import context_diff
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union
 
@@ -227,7 +228,6 @@ def read_config_file(config_file: Union[str, Path, None] = None) -> Dict[str, An
     if config_path.suffix == ".cfg":
         return read_ini_file(config_path)
     elif config_path.suffix == ".toml":
-        logger.info("Reading config file %s:", config_path)
         return read_toml_file(config_path)
     return {}
 
@@ -363,7 +363,19 @@ def update_config_file(
         config_path,
     )
 
-    logger.info(new_config)
+    logger.info(
+        "\n".join(
+            list(
+                context_diff(
+                    existing_config.splitlines(),
+                    new_config.splitlines(),
+                    fromfile=f"before {config_path}",
+                    tofile=f"after {config_path}",
+                    lineterm="",
+                )
+            )
+        )
+    )
 
     if not dry_run:
         config_path.write_text(new_config)

bumpversion/files.py

@@ -1,6 +1,7 @@
 """Methods for changing files."""
 import glob
 import logging
+from difflib import context_diff
 from typing import List, MutableMapping
 
 from bumpversion.config import FileConfig
@@ -92,8 +93,6 @@ def replace_version(
         self, current_version: Version, new_version: Version, context: MutableMapping, dry_run: bool = False
     ) -> None:
         """Replace the current version with the new version."""
-        from difflib import unified_diff
-
         with open(self.path, "rt", encoding="utf-8") as f:
             file_content_before = f.read()
             file_new_lines = f.newlines[0] if isinstance(f.newlines, tuple) else f.newlines
@@ -115,12 +114,12 @@ def replace_version(
             logger.info(
                 "\n".join(
                     list(
-                        unified_diff(
+                        context_diff(
                             file_content_before.splitlines(),
                             file_content_after.splitlines(),
+                            fromfile=f"before {self.path}",
+                            tofile=f"after {self.path}",
                             lineterm="",
-                            fromfile=f"a/{self.path}",
-                            tofile=f"b/{self.path}",
                         )
                     )
                 )
@@ -207,7 +206,7 @@ def _check_files_contain_version(
     """Make sure files exist and contain version string."""
     logger.info(
         "Asserting files %s contain the version string...",
-        ", ".join([str(f) for f in files]),
+        ", ".join({str(f.path) for f in files}),
     )
     for f in files:
         f.contains_version(current_version, context)

bumpversion/logging.py

@@ -19,5 +19,7 @@ def setup_logging(verbose: int = 0) -> None:
         level=VERBOSITY.get(verbose, logging.DEBUG),
         format="%(message)s",
         datefmt="[%X]",
-        handlers=[RichHandler(rich_tracebacks=True, tracebacks_suppress=[click])],
+        handlers=[RichHandler(rich_tracebacks=True, show_path=False, show_time=False, tracebacks_suppress=[click])],
     )
+    root_logger = logging.getLogger("")
+    root_logger.setLevel(VERBOSITY.get(verbose, logging.DEBUG))

bumpversion/scm.py

@@ -47,7 +47,7 @@ def commit(cls, message: str, current_version: str, new_version: str, extra_args
         env["BUMPVERSION_NEW_VERSION"] = new_version
 
         try:
-            subprocess.check_output([*cls._COMMIT_COMMAND, f.name, *extra_args], env=env)
+            subprocess.run([*cls._COMMIT_COMMAND, f.name, *extra_args], env=env, capture_output=True, check=True)
         except subprocess.CalledProcessError as exc:
             err_msg = f"Failed to run {exc.cmd}: return code {exc.returncode}, output: {exc.output}"
             logger.exception(err_msg)
@@ -59,7 +59,7 @@ def commit(cls, message: str, current_version: str, new_version: str, extra_args
     def is_usable(cls) -> bool:
         """Is the VCS implementation usable."""
         try:
-            result = subprocess.run(cls._TEST_USABLE_COMMAND, check=True)
+            result = subprocess.run(cls._TEST_USABLE_COMMAND, check=True, capture_output=True)
             return result.returncode == 0
         except (FileNotFoundError, PermissionError, NotADirectoryError, subprocess.CalledProcessError):
             return False
@@ -172,8 +172,12 @@ def latest_tag_info(cls, tag_pattern: str) -> SCMInfo:
         """Return information about the latest tag."""
         try:
             # git-describe doesn't update the git-index, so we do that
-            subprocess.run(["git", "update-index", "--refresh"], check=True)
+            subprocess.run(["git", "update-index", "--refresh", "-q"], capture_output=True)
+        except subprocess.CalledProcessError as e:
+            logger.debug("Error when running git update-index: %s", e.stderr)
+            return SCMInfo(tool=cls)
 
+        try:
             # get info about the latest tag in git
             # TODO: This only works if the tag name is prefixed with `v`.
             #   Should allow for the configured format for the tag name.
@@ -188,8 +192,8 @@ def latest_tag_info(cls, tag_pattern: str) -> SCMInfo:
             ]
             result = subprocess.run(git_cmd, text=True, check=True, capture_output=True)
             describe_out = result.stdout.strip().split("-")
-        except subprocess.CalledProcessError:
-            logger.debug("Error when running git describe")
+        except subprocess.CalledProcessError as e:
+            logger.debug("Error when running git describe: %s", e.stderr)
             return SCMInfo(tool=cls)
 
         info = SCMInfo()