Added --ignore-missing-version flag to bump and replace

callowayproject · Jul 13, 2023 · a5bd008 · a5bd008
1 parent 45c85be
commit a5bd008
Show file tree

Hide file tree

Showing 7 changed files with 140 additions and 42 deletions.
diff --git a/bumpversion/cli.py b/bumpversion/cli.py
@@ -148,6 +148,12 @@ def cli(ctx: Context) -> None:
         "ignoring the files from the configuration file."
     ),
 )
+@click.option(
+    "--ignore-missing-version",
+    is_flag=True,
+    envvar="BUMPVERSION_IGNORE_MISSING_VERSION",
+    help="Ignore any Version Not Found errors when searching and replacing in files.",
+)
 @click.option(
     "--dry-run",
     "-n",
@@ -221,6 +227,7 @@ def bump(
     search: Optional[str],
     replace: Optional[str],
     no_configured_files: bool,
+    ignore_missing_version: bool,
     dry_run: bool,
     commit: Optional[bool],
     tag: Optional[bool],
@@ -261,6 +268,7 @@ def bump(
         tag_message=tag_message,
         message=message,
         commit_args=commit_args,
+        ignore_missing_version=ignore_missing_version,
     )
 
     found_config_file = find_config_file(config_file)
@@ -408,6 +416,12 @@ def show(args: List[str], config_file: Optional[str], format_: str, increment: O
         "ignoring the files from the configuration file."
     ),
 )
+@click.option(
+    "--ignore-missing-version",
+    is_flag=True,
+    envvar="BUMPVERSION_IGNORE_MISSING_VERSION",
+    help="Ignore any Version Not Found errors when searching and replacing in files.",
+)
 @click.option(
     "--dry-run",
     "-n",
@@ -427,6 +441,7 @@ def replace(
     search: Optional[str],
     replace: Optional[str],
     no_configured_files: bool,
+    ignore_missing_version: bool,
     dry_run: bool,
 ) -> None:
     """
@@ -453,6 +468,7 @@ def replace(
         tag_message=None,
         message=None,
         commit_args=None,
+        ignore_missing_version=ignore_missing_version,
     )
 
     found_config_file = find_config_file(config_file)

diff --git a/bumpversion/files.py b/bumpversion/files.py
@@ -26,6 +26,7 @@ def __init__(
         self.serialize = file_cfg.serialize or version_config.serialize_formats
         self.search = search or file_cfg.search or version_config.search
         self.replace = replace or file_cfg.replace or version_config.replace
+        self.ignore_missing_version = file_cfg.ignore_missing_version or False
         self.version_config = VersionConfig(
             self.parse, self.serialize, self.search, self.replace, version_config.part_configs
         )
@@ -63,6 +64,8 @@ def contains_version(self, version: Version, context: MutableMapping) -> bool:
             return True
 
         # version not found
+        if self.ignore_missing_version:
+            return False
         raise VersionNotFoundError(f"Did not find '{search_expression}' in file: '{self.path}'")
 
     def contains(self, search: str) -> bool:

diff --git a/tests/fixtures/basic_cfg_expected.txt b/tests/fixtures/basic_cfg_expected.txt
@@ -4,22 +4,29 @@
  'current_version': '1.0.0',
  'files': [{'filename': 'setup.py',
             'glob': None,
-            'parse': None,
-            'replace': None,
-            'search': None,
-            'serialize': None},
+            'ignore_missing_version': False,
+            'parse': '(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?',
+            'replace': '{new_version}',
+            'search': '{current_version}',
+            'serialize': ['{major}.{minor}.{patch}-{release}',
+                          '{major}.{minor}.{patch}']},
            {'filename': 'bumpversion/__init__.py',
             'glob': None,
-            'parse': None,
-            'replace': None,
-            'search': None,
-            'serialize': None},
+            'ignore_missing_version': False,
+            'parse': '(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?',
+            'replace': '{new_version}',
+            'search': '{current_version}',
+            'serialize': ['{major}.{minor}.{patch}-{release}',
+                          '{major}.{minor}.{patch}']},
            {'filename': 'CHANGELOG.md',
             'glob': None,
-            'parse': None,
+            'ignore_missing_version': False,
+            'parse': '(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?',
             'replace': '**unreleased**\n**v{new_version}**',
             'search': '**unreleased**',
-            'serialize': None}],
+            'serialize': ['{major}.{minor}.{patch}-{release}',
+                          '{major}.{minor}.{patch}']}],
+ 'ignore_missing_version': False,
  'message': 'Bump version: {current_version} → {new_version}',
  'parse': '(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?',
  'parts': {'major': {'first_value': None,

diff --git a/tests/fixtures/basic_cfg_expected.yaml b/tests/fixtures/basic_cfg_expected.yaml
@@ -5,22 +5,32 @@ current_version: "1.0.0"
 files:
   - filename: "setup.py"
     glob: null
-    parse: null
-    replace: null
-    search: null
-    serialize: null
+    ignore_missing_version: false
+    parse: "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?"
+    replace: "{new_version}"
+    search: "{current_version}"
+    serialize:
+      - "{major}.{minor}.{patch}-{release}"
+      - "{major}.{minor}.{patch}"
   - filename: "bumpversion/__init__.py"
     glob: null
-    parse: null
-    replace: null
-    search: null
-    serialize: null
+    ignore_missing_version: false
+    parse: "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?"
+    replace: "{new_version}"
+    search: "{current_version}"
+    serialize:
+      - "{major}.{minor}.{patch}-{release}"
+      - "{major}.{minor}.{patch}"
   - filename: "CHANGELOG.md"
     glob: null
-    parse: null
+    ignore_missing_version: false
+    parse: "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?"
     replace: "**unreleased**\n**v{new_version}**"
     search: "**unreleased**"
-    serialize: null
+    serialize:
+      - "{major}.{minor}.{patch}-{release}"
+      - "{major}.{minor}.{patch}"
+ignore_missing_version: false
 message: "Bump version: {current_version} → {new_version}"
 parse: "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?"
 parts:

diff --git a/tests/fixtures/basic_cfg_expected_full.json b/tests/fixtures/basic_cfg_expected_full.json
@@ -7,28 +7,41 @@
     {
       "filename": "setup.py",
       "glob": null,
-      "parse": null,
-      "replace": null,
-      "search": null,
-      "serialize": null
+      "ignore_missing_version": false,
+      "parse": "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?",
+      "replace": "{new_version}",
+      "search": "{current_version}",
+      "serialize": [
+        "{major}.{minor}.{patch}-{release}",
+        "{major}.{minor}.{patch}"
+      ]
     },
     {
       "filename": "bumpversion/__init__.py",
       "glob": null,
-      "parse": null,
-      "replace": null,
-      "search": null,
-      "serialize": null
+      "ignore_missing_version": false,
+      "parse": "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?",
+      "replace": "{new_version}",
+      "search": "{current_version}",
+      "serialize": [
+        "{major}.{minor}.{patch}-{release}",
+        "{major}.{minor}.{patch}"
+      ]
     },
     {
       "filename": "CHANGELOG.md",
       "glob": null,
-      "parse": null,
+      "ignore_missing_version": false,
+      "parse": "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?",
       "replace": "**unreleased**\n**v{new_version}**",
       "search": "**unreleased**",
-      "serialize": null
+      "serialize": [
+        "{major}.{minor}.{patch}-{release}",
+        "{major}.{minor}.{patch}"
+      ]
     }
   ],
+  "ignore_missing_version": false,
   "message": "Bump version: {current_version} \u2192 {new_version}",
   "parse": "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?",
   "parts": {

diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -196,12 +196,16 @@ def test_listing_with_version_part(tmp_path: Path, fixtures_path: Path):
 
     assert result.exit_code == 0
     assert set(result.output.splitlines(keepends=False)) == {
+        "WARNING:",
+        "",
+        "DEPRECATED: The --list option is deprecated and will be removed in a future version.",
         "new_version=1.0.1-dev",
         "current_version=1.0.0",
         "parse=(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?",
         "serialize=['{major}.{minor}.{patch}-{release}', '{major}.{minor}.{patch}']",
         "search={current_version}",
         "replace={new_version}",
+        "ignore_missing_version=False",
         "tag=True",
         "sign_tags=False",
         "tag_name=v{new_version}",
@@ -210,12 +214,21 @@ def test_listing_with_version_part(tmp_path: Path, fixtures_path: Path):
         "commit=True",
         "message=Bump version: {current_version} → {new_version}",
         "commit_args=None",
-        "files=[{'filename': 'setup.py', 'glob': None, 'parse': None, 'serialize': "
-        "None, 'search': None, 'replace': None}, {'filename': "
-        "'bumpversion/__init__.py', 'glob': None, 'parse': None, 'serialize': None, "
-        "'search': None, 'replace': None}, {'filename': 'CHANGELOG.md', 'glob': None, "
-        "'parse': None, 'serialize': None, 'search': '**unreleased**', 'replace': "
-        "'**unreleased**\\n**v{new_version}**'}]",
+        (
+            "files=["
+            "{'filename': 'setup.py', 'glob': None, 'parse': "
+            "'(?P<major>\\\\d+)\\\\.(?P<minor>\\\\d+)\\\\.(?P<patch>\\\\d+)(\\\\-(?P<release>[a-z]+))?', 'serialize': "
+            "['{major}.{minor}.{patch}-{release}', '{major}.{minor}.{patch}'], 'search': '{current_version}', "
+            "'replace': '{new_version}', 'ignore_missing_version': False}, "
+            "{'filename': 'bumpversion/__init__.py', 'glob': None, 'parse': "
+            "'(?P<major>\\\\d+)\\\\.(?P<minor>\\\\d+)\\\\.(?P<patch>\\\\d+)(\\\\-(?P<release>[a-z]+))?', 'serialize': "
+            "['{major}.{minor}.{patch}-{release}', '{major}.{minor}.{patch}'], 'search': '{current_version}', "
+            "'replace': '{new_version}', 'ignore_missing_version': False}, "
+            "{'filename': 'CHANGELOG.md', 'glob': None, 'parse': "
+            "'(?P<major>\\\\d+)\\\\.(?P<minor>\\\\d+)\\\\.(?P<patch>\\\\d+)(\\\\-(?P<release>[a-z]+))?', 'serialize': "
+            "['{major}.{minor}.{patch}-{release}', '{major}.{minor}.{patch}'], 'search': '**unreleased**', "
+            "'replace': '**unreleased**\\n**v{new_version}**', 'ignore_missing_version': False}]"
+        ),
     }
 
 
@@ -236,11 +249,15 @@ def test_listing_without_version_part(tmp_path: Path, fixtures_path: Path):
 
     assert result.exit_code == 0
     assert set(result.output.splitlines(keepends=False)) == {
+        "WARNING:",
+        "",
+        "DEPRECATED: The --list option is deprecated and will be removed in a future version.",
         "current_version=1.0.0",
         "parse=(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?",
         "serialize=['{major}.{minor}.{patch}-{release}', '{major}.{minor}.{patch}']",
         "search={current_version}",
         "replace={new_version}",
+        "ignore_missing_version=False",
         "tag=True",
         "sign_tags=False",
         "tag_name=v{new_version}",
@@ -249,12 +266,21 @@ def test_listing_without_version_part(tmp_path: Path, fixtures_path: Path):
         "commit=True",
         "message=Bump version: {current_version} → {new_version}",
         "commit_args=None",
-        "files=[{'filename': 'setup.py', 'glob': None, 'parse': None, 'serialize': "
-        "None, 'search': None, 'replace': None}, {'filename': "
-        "'bumpversion/__init__.py', 'glob': None, 'parse': None, 'serialize': None, "
-        "'search': None, 'replace': None}, {'filename': 'CHANGELOG.md', 'glob': None, "
-        "'parse': None, 'serialize': None, 'search': '**unreleased**', 'replace': "
-        "'**unreleased**\\n**v{new_version}**'}]",
+        (
+            "files=["
+            "{'filename': 'setup.py', 'glob': None, 'parse': "
+            "'(?P<major>\\\\d+)\\\\.(?P<minor>\\\\d+)\\\\.(?P<patch>\\\\d+)(\\\\-(?P<release>[a-z]+))?', 'serialize': "
+            "['{major}.{minor}.{patch}-{release}', '{major}.{minor}.{patch}'], 'search': '{current_version}', "
+            "'replace': '{new_version}', 'ignore_missing_version': False}, "
+            "{'filename': 'bumpversion/__init__.py', 'glob': None, 'parse': "
+            "'(?P<major>\\\\d+)\\\\.(?P<minor>\\\\d+)\\\\.(?P<patch>\\\\d+)(\\\\-(?P<release>[a-z]+))?', 'serialize': "
+            "['{major}.{minor}.{patch}-{release}', '{major}.{minor}.{patch}'], 'search': '{current_version}', "
+            "'replace': '{new_version}', 'ignore_missing_version': False}, "
+            "{'filename': 'CHANGELOG.md', 'glob': None, 'parse': "
+            "'(?P<major>\\\\d+)\\\\.(?P<minor>\\\\d+)\\\\.(?P<patch>\\\\d+)(\\\\-(?P<release>[a-z]+))?', 'serialize': "
+            "['{major}.{minor}.{patch}-{release}', '{major}.{minor}.{patch}'], 'search': '**unreleased**', "
+            "'replace': '**unreleased**\\n**v{new_version}**', 'ignore_missing_version': False}]"
+        ),
     }
 
 

diff --git a/tests/test_files.py b/tests/test_files.py
@@ -366,3 +366,26 @@ def test_multi_line_search_is_found(tmp_path: Path) -> None:
 
     # Assert
     assert alphabet_path.read_text() == "A\nB\nC\n10.0.0\n"
+
+
+def test_ignore_missing_version(tmp_path: Path) -> None:
+    """If the version is not found in the file, do nothing."""
+    # Arrange
+    version_path = tmp_path / Path("VERSION")
+    version_path.write_text("1.2.3")
+
+    overrides = {
+        "current_version": "1.2.5",
+        "ignore_missing_version": True,
+        "files": [{"filename": str(version_path)}],
+    }
+    conf, version_config, current_version = get_config_data(overrides)
+    assert conf.ignore_missing_version is True
+    new_version = current_version.bump("patch", version_config.order)
+    cfg_files = [files.ConfiguredFile(file_cfg, version_config) for file_cfg in conf.files]
+
+    # Act
+    files.modify_files(cfg_files, current_version, new_version, get_context(conf))
+
+    # Assert
+    assert version_path.read_text() == "1.2.3"