Keep build backend output off metadata stdout#2309
Open
marko1olo wants to merge 1 commit into
Open
Conversation
Author
|
Local verification on
Note: I had to set |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #2069.
When Hatch reads metadata through a non-Hatchling build backend, the PEP 517 hook runs in a child process. Some backends, notably setuptools/setuptools-scm, print build progress such as
running egg_infoto stdout while preparing metadata. That output was forwarded directly to Hatch's stdout before Hatch printed the requested version/metadata, which makes commands likehatch versionhard to use from scripts.This redirects backend stdout to stderr for the standard frontend runner. Hatch still preserves backend diagnostics, but stdout remains reserved for Hatch's actual command result.
I verified this with a setuptools-scm sample project: after this change,
hatch versionstdout is only1.2.3, whilerunning egg_inforemains visible on stderr.Tests run:
python -m ruff check src/hatch/project/frontend/scripts/standard.py tests/project/test_frontend.pypython -m ruff format --check src/hatch/project/frontend/scripts/standard.py tests/project/test_frontend.pypython -m pytest tests/project/test_frontend.py tests/cli/version/test_version.py::test_other_backend_show tests/cli/project/test_metadata.py::test_other_backend -qpython scripts/validate_history.pygit diff --check