Skip to content

Commit 5c6dc6c

Browse files
authored
Strip surrounding whitespace from version metadata (#2438)
1 parent 0941887 commit 5c6dc6c

2 files changed

Lines changed: 26 additions & 4 deletions

File tree

‎backend/src/hatchling/metadata/core.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ def version(self) -> str:
157157
@property
158158
def original_version(self) -> str:
159159
"""
160-
The version as written by the user, before PEP 440 normalization.
160+
The version as written by the user, with surrounding whitespace removed.
161161
162162
The normalized `version` is used for distribution file names and `.dist-info`
163163
directories, but core metadata records the original string so that stylized
@@ -275,7 +275,7 @@ def _get_version(self, core_metadata: CoreMetadata | None = None) -> str:
275275
message = f"Invalid version `{version}` from {source}, see https://peps.python.org/pep-0440/"
276276
raise ValueError(message) from None
277277
else:
278-
self._original_version = version
278+
self._original_version = version.strip()
279279
return normalized_version
280280

281281
def validate_fields(self) -> None:

‎tests/backend/metadata/test_core.py‎

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,8 +228,11 @@ def test_static_normalization(self, isolation):
228228
assert metadata.version == metadata.version == "0.1.0.0rc1"
229229
assert metadata.core.version == metadata.core.version == "0.1.0.0-rc.1"
230230

231-
def test_original_version_preserved(self, isolation):
232-
metadata = ProjectMetadata(str(isolation), None, {"project": {"version": "2026.08.10"}})
231+
@pytest.mark.parametrize("whitespace", ["", "\n", "\r\n", " \t\r\n\f\v"])
232+
def test_original_version_preserved(self, isolation, whitespace):
233+
metadata = ProjectMetadata(
234+
str(isolation), None, {"project": {"version": f"{whitespace}2026.08.10{whitespace}"}}
235+
)
233236

234237
assert metadata.version == "2026.8.10"
235238
assert metadata.original_version == metadata.original_version == "2026.08.10"
@@ -307,6 +310,25 @@ def test_dynamic_source_regex_invalid(self, temp_dir):
307310
):
308311
_ = metadata.version
309312

313+
@pytest.mark.parametrize("constructor", get_core_metadata_constructors().values())
314+
def test_dynamic_source_regex_trailing_newline(self, constructor, temp_dir):
315+
metadata = ProjectMetadata(
316+
str(temp_dir),
317+
PluginManager(),
318+
{
319+
"project": {"name": "my-app", "dynamic": ["version"], "dependencies": ["anyio==4.3.0"]},
320+
"tool": {"hatch": {"version": {"path": "VERSION", "pattern": "(?P<version>[^']+)"}}},
321+
},
322+
)
323+
(temp_dir / "VERSION").write_text("2026.08.10\n")
324+
325+
assert metadata.version == "2026.8.10"
326+
assert project_metadata_from_core_metadata(constructor(metadata)) == {
327+
"name": "my-app",
328+
"version": "2026.08.10",
329+
"dependencies": ["anyio==4.3.0"],
330+
}
331+
310332
def test_dynamic_error(self, isolation):
311333
metadata = ProjectMetadata(
312334
str(isolation),

0 commit comments

Comments
 (0)