Skip to content

Commit 66f167a

Browse files
committed
Ensure README changes don't affect whitespace
1 parent b217961 commit 66f167a

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

release.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -446,9 +446,9 @@ def tweak_readme(tag: Tag, filename: str = "README.rst") -> None:
446446
print(f"Updating {filename}...", end=" ")
447447
readme = Path(filename)
448448

449-
# Update first line: "This is Python version 3.14.0 alpha 7"
449+
# Update first line: "This is Python version X.Y.Z {release_level} N"
450450
# and update length of underline in second line to match.
451-
lines = readme.read_text().splitlines()
451+
lines = readme.read_text(encoding="utf-8").split("\n")
452452
this_is = f"This is Python version {tag.long_name}"
453453
underline = "=" * len(this_is)
454454
lines[0] = this_is

tests/test_release.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,16 +102,19 @@ def test_tweak_readme(
102102
tag = release.Tag(test_tag)
103103

104104
original_readme_file = Path(__file__).parent / "README.rst"
105-
original_contents = original_readme_file.read_text()
105+
original_contents = original_readme_file.read_text(encoding="utf-8")
106106
readme_file = tmp_path / "README.rst"
107107
readme_file.write_text(original_contents)
108108

109109
# Act
110110
release.tweak_readme(tag, filename=str(readme_file))
111111

112112
# Assert
113-
original_lines = original_contents.splitlines()
114-
new_lines = readme_file.read_text().splitlines()
113+
original_lines = original_contents.split("\n")
114+
new_contents = readme_file.read_text(encoding="utf-8")
115+
new_lines = new_contents.split("\n")
115116
assert new_lines[0] == expected_version
116117
assert new_lines[1] == expected_underline
117118
assert new_lines[2:] == original_lines[2:]
119+
assert original_contents.endswith("\n")
120+
assert new_contents.endswith("\n")

0 commit comments

Comments
 (0)