Thanks to visit codestin.com
Credit goes to github.com

Skip to content

refactor(bump): cleanup related to update_version_file #1594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+207 −56
Open

refactor(bump): cleanup related to update_version_file #1594

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 33 additions & 48 deletions commitizen/bump.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
import os
import re
from collections import OrderedDict
from collections.abc import Iterable
from collections.abc import Generator, Iterable
from glob import iglob
from logging import getLogger
from string import Template
from typing import cast

from commitizen.defaults import BUMP_MESSAGE, ENCODING, MAJOR, MINOR, PATCH
from commitizen.defaults import BUMP_MESSAGE, MAJOR, MINOR, PATCH
from commitizen.exceptions import CurrentVersionNotFoundError
from commitizen.git import GitCommit, smart_open
from commitizen.version_schemes import Increment, Version
Expand Down Expand Up @@ -64,8 +64,8 @@ def update_version_in_files(
new_version: str,
files: Iterable[str],
*,
check_consistency: bool = False,
encoding: str = ENCODING,
check_consistency: bool,
encoding: str,
Comment on lines -67 to +68
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe we don't need this default argument. These only introduce unnecessary complexity.

) -> list[str]:
"""Change old version to the new one in every file given.

Expand All @@ -75,16 +75,22 @@ def update_version_in_files(

Returns the list of updated files.
"""
# TODO: separate check step and write step
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this TODO is already addressed

Copy link
Contributor Author

@bearomorphism bearomorphism Sep 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Lee-W you left this TODO according to the git history, could you help to confirm this? Thanks.

updated = []
for path, regex in _files_and_regexes(files, current_version):
current_version_found, version_file = _bump_with_regex(
path,
current_version,
new_version,
regex,
encoding=encoding,
)
updated_files = []

for path, pattern in _resolve_files_and_regexes(files, current_version):
current_version_found = False
bumped_lines = []

with open(path, encoding=encoding) as version_file:
for line in version_file:
bumped_line = (
line.replace(current_version, new_version)
if pattern.search(line)
else line
)

current_version_found = current_version_found or bumped_line != line
bumped_lines.append(bumped_line)

if check_consistency and not current_version_found:
raise CurrentVersionNotFoundError(
Expand All @@ -93,53 +99,32 @@ def update_version_in_files(
"version_files are possibly inconsistent."
)

bumped_version_file_content = "".join(bumped_lines)

# Write the file out again
with smart_open(path, "w", encoding=encoding) as file:
file.write(version_file)
updated.append(path)
return updated
file.write(bumped_version_file_content)
updated_files.append(path)

return updated_files


def _files_and_regexes(patterns: Iterable[str], version: str) -> list[tuple[str, str]]:
def _resolve_files_and_regexes(
patterns: Iterable[str], version: str
) -> Generator[tuple[str, re.Pattern], None, None]:
"""
Resolve all distinct files with their regexp from a list of glob patterns with optional regexp
"""
out: set[tuple[str, str]] = set()
filepath_set: set[tuple[str, str]] = set()
for pattern in patterns:
drive, tail = os.path.splitdrive(pattern)
path, _, regex = tail.partition(":")
filepath = drive + path
if not regex:
regex = re.escape(version)
regex = regex or re.escape(version)

for file in iglob(filepath):
out.add((file, regex))
filepath_set.update((path, regex) for path in iglob(filepath))

return sorted(out)


def _bump_with_regex(
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe we don't need this extra layer of abstraction.

version_filepath: str,
current_version: str,
new_version: str,
regex: str,
encoding: str = ENCODING,
) -> tuple[bool, str]:
current_version_found = False
lines = []
pattern = re.compile(regex)
with open(version_filepath, encoding=encoding) as f:
for line in f:
if not pattern.search(line):
lines.append(line)
continue

bumped_line = line.replace(current_version, new_version)
if bumped_line != line:
current_version_found = True
lines.append(bumped_line)

return current_version_found, "".join(lines)
return ((path, re.compile(regex)) for path, regex in sorted(filepath_set))


def create_commit_message(
Expand Down
182 changes: 174 additions & 8 deletions tests/test_bump_update_version_in_files.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,11 @@ def test_update_version_in_files(version_files, file_regression):
old_version = "1.2.3"
new_version = "2.0.0"
bump.update_version_in_files(
old_version, new_version, version_files, encoding="utf-8"
old_version,
new_version,
version_files,
check_consistency=False,
encoding="utf-8",
)

file_contents = ""
Expand All @@ -119,7 +123,9 @@ def test_partial_update_of_file(version_repeated_file, file_regression):
regex = "version"
location = f"{version_repeated_file}:{regex}"

bump.update_version_in_files(old_version, new_version, [location], encoding="utf-8")
bump.update_version_in_files(
old_version, new_version, [location], check_consistency=False, encoding="utf-8"
)
with open(version_repeated_file, encoding="utf-8") as f:
file_regression.check(f.read(), extension=".json")

Expand All @@ -129,7 +135,9 @@ def test_random_location(random_location_version_file, file_regression):
new_version = "2.0.0"
location = f"{random_location_version_file}:version.+Commitizen"

bump.update_version_in_files(old_version, new_version, [location], encoding="utf-8")
bump.update_version_in_files(
old_version, new_version, [location], check_consistency=False, encoding="utf-8"
)
with open(random_location_version_file, encoding="utf-8") as f:
file_regression.check(f.read(), extension=".lock")

Expand All @@ -141,7 +149,9 @@ def test_duplicates_are_change_with_no_regex(
new_version = "2.0.0"
location = f"{random_location_version_file}:version"

bump.update_version_in_files(old_version, new_version, [location], encoding="utf-8")
bump.update_version_in_files(
old_version, new_version, [location], check_consistency=False, encoding="utf-8"
)
with open(random_location_version_file, encoding="utf-8") as f:
file_regression.check(f.read(), extension=".lock")

Expand All @@ -153,7 +163,9 @@ def test_version_bump_increase_string_length(
new_version = "1.2.10"
location = f"{multiple_versions_increase_string}:version"

bump.update_version_in_files(old_version, new_version, [location], encoding="utf-8")
bump.update_version_in_files(
old_version, new_version, [location], check_consistency=False, encoding="utf-8"
)
with open(multiple_versions_increase_string, encoding="utf-8") as f:
file_regression.check(f.read(), extension=".txt")

Expand All @@ -165,7 +177,9 @@ def test_version_bump_reduce_string_length(
new_version = "2.0.0"
location = f"{multiple_versions_reduce_string}:version"

bump.update_version_in_files(old_version, new_version, [location], encoding="utf-8")
bump.update_version_in_files(
old_version, new_version, [location], check_consistency=False, encoding="utf-8"
)
with open(multiple_versions_reduce_string, encoding="utf-8") as f:
file_regression.check(f.read(), extension=".txt")

Expand Down Expand Up @@ -204,7 +218,9 @@ def test_multiple_versions_to_bump(
new_version = "1.2.10"
location = f"{multiple_versions_to_update_poetry_lock}:version"

bump.update_version_in_files(old_version, new_version, [location], encoding="utf-8")
bump.update_version_in_files(
old_version, new_version, [location], check_consistency=False, encoding="utf-8"
)
with open(multiple_versions_to_update_poetry_lock, encoding="utf-8") as f:
file_regression.check(f.read(), extension=".toml")

Expand All @@ -220,8 +236,158 @@ def test_update_version_in_globbed_files(commitizen_config_file, file_regression
version_files = [commitizen_config_file.dirpath("*.toml")]

bump.update_version_in_files(
old_version, new_version, version_files, encoding="utf-8"
old_version,
new_version,
version_files,
check_consistency=False,
encoding="utf-8",
)

for file in commitizen_config_file, other:
file_regression.check(file.read_text("utf-8"), extension=".toml")


def test_update_version_in_files_with_check_consistency_true(version_files):
"""Test update_version_in_files with check_consistency=True (success case)."""
old_version = "1.2.3"
new_version = "2.0.0"

# This should succeed because all files contain the current version
updated_files = bump.update_version_in_files(
old_version,
new_version,
version_files,
check_consistency=True,
encoding="utf-8",
)

# Verify that all files were updated
assert len(updated_files) == len(version_files)
for file_path in updated_files:
assert file_path in version_files


def test_update_version_in_files_with_check_consistency_true_failure(
commitizen_config_file, inconsistent_python_version_file
):
"""Test update_version_in_files with check_consistency=True (failure case)."""
old_version = "1.2.3"
new_version = "2.0.0"
version_files = [commitizen_config_file, inconsistent_python_version_file]

# This should fail because inconsistent_python_version_file doesn't contain the current version
with pytest.raises(CurrentVersionNotFoundError) as excinfo:
bump.update_version_in_files(
old_version,
new_version,
version_files,
check_consistency=True,
encoding="utf-8",
)

expected_msg = (
f"Current version {old_version} is not found in {inconsistent_python_version_file}.\n"
"The version defined in commitizen configuration and the ones in "
"version_files are possibly inconsistent."
)
assert expected_msg in str(excinfo.value)


@pytest.mark.parametrize(
"encoding,filename",
[
("latin-1", "test_latin1.txt"),
("utf-16", "test_utf16.txt"),
],
ids=["latin-1", "utf-16"],
)
def test_update_version_in_files_with_different_encodings(tmp_path, encoding, filename):
"""Test update_version_in_files with different encodings."""
# Create a test file with the specified encoding
test_file = tmp_path / filename
content = f'version = "1.2.3"\n# This is a test file with {encoding} encoding\n'
test_file.write_text(content, encoding=encoding)

old_version = "1.2.3"
new_version = "2.0.0"

updated_files = bump.update_version_in_files(
old_version,
new_version,
[str(test_file)],
check_consistency=True,
encoding=encoding,
)

# Verify the file was updated
assert len(updated_files) == 1
assert str(test_file) in updated_files

# Verify the content was updated correctly
updated_content = test_file.read_text(encoding=encoding)
assert f'version = "{new_version}"' in updated_content
assert f'version = "{old_version}"' not in updated_content


def test_update_version_in_files_return_value(version_files):
"""Test that update_version_in_files returns the correct list of updated files."""
old_version = "1.2.3"
new_version = "2.0.0"

updated_files = bump.update_version_in_files(
old_version,
new_version,
version_files,
check_consistency=False,
encoding="utf-8",
)

# Verify return value is a list
assert isinstance(updated_files, list)

# Verify all files in the input are in the returned list
assert len(updated_files) == len(version_files)
for file_path in version_files:
assert file_path in updated_files

# Verify the returned paths are strings
for file_path in updated_files:
assert isinstance(file_path, str)


def test_update_version_in_files_return_value_partial_update(tmp_path):
"""Test return value when only some files are updated."""
# Create two test files
file1 = tmp_path / "file1.txt"
file2 = tmp_path / "file2.txt"

# File1 contains the version to update
file1.write_text('version = "1.2.3"\n')

# File2 doesn't contain the version
file2.write_text("some other content\n")

old_version = "1.2.3"
new_version = "2.0.0"

updated_files = bump.update_version_in_files(
old_version,
new_version,
[str(file1), str(file2)],
check_consistency=False,
encoding="utf-8",
)

# Verify return value
assert isinstance(updated_files, list)
assert len(updated_files) == 2 # Both files should be in the list
assert str(file1) in updated_files
assert str(file2) in updated_files

# Verify file1 was actually updated
content1 = file1.read_text(encoding="utf-8")
assert f'version = "{new_version}"' in content1

# Verify file2 was not changed
content2 = file2.read_text(encoding="utf-8")
assert content2 == "some other content\n"
Loading