-
Notifications
You must be signed in to change notification settings - Fork 50
fix(output): standardize --output to work for all formats #1193
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.
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
shifa-khan
wants to merge
1
commit into
python-wheel-build:main
Choose a base branch
from
shifa-khan:1177
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -329,21 +329,40 @@ def test_list_versions_output_file( | |
| assert len(data) == 3 | ||
|
|
||
|
|
||
| def test_list_versions_output_ignored_for_plain_formats( | ||
| def test_list_versions_output_file_versions_format( | ||
| cli_runner: CliRunner, tmp_path: pathlib.Path | ||
| ) -> None: | ||
| """--output is ignored with a warning for 'versions' and 'requirements' formats.""" | ||
| """--output writes plain version list to a file for 'versions' format.""" | ||
| output_file = tmp_path / "versions.txt" | ||
| for fmt in ("versions", "requirements"): | ||
| result = _invoke_list_versions( | ||
| cli_runner, | ||
| extra_args=["--format", fmt, "--output", str(output_file)], | ||
| ) | ||
| assert result.exit_code == 0 | ||
| assert not output_file.exists(), ( | ||
| f"--output should be ignored for --format {fmt}" | ||
| ) | ||
| assert "Warning: --output option is ignored" in result.output | ||
| result = _invoke_list_versions( | ||
| cli_runner, | ||
| extra_args=["--format", "versions", "--output", str(output_file)], | ||
| ) | ||
| assert result.exit_code == 0 | ||
| assert output_file.exists() | ||
| content = output_file.read_text() | ||
| lines = [line for line in content.strip().split("\n") if line.strip()] | ||
| assert "1.2.2" in lines | ||
| assert "1.3.2" in lines | ||
| assert "2.0.0" in lines | ||
|
|
||
|
Comment on lines
+332
to
+348
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Assert stdout remains data-free when These tests only validate file contents. They should also verify the command does not emit plain version/pin data to stdout when Suggested patch def test_list_versions_output_file_versions_format(
@@
lines = [line for line in content.strip().split("\n") if line.strip()]
assert "1.2.2" in lines
assert "1.3.2" in lines
assert "2.0.0" in lines
+ assert "1.2.2" not in result.stdout
+ assert "1.3.2" not in result.stdout
+ assert "2.0.0" not in result.stdout
@@
def test_list_versions_output_file_requirements_format(
@@
lines = [line for line in content.strip().split("\n") if line.strip()]
assert "test-pkg==1.2.2" in lines
assert "test-pkg==1.3.2" in lines
assert "test-pkg==2.0.0" in lines
+ assert "test-pkg==1.2.2" not in result.stdout
+ assert "test-pkg==1.3.2" not in result.stdout
+ assert "test-pkg==2.0.0" not in result.stdoutAlso applies to: 350-365 🤖 Prompt for AI Agents |
||
|
|
||
| def test_list_versions_output_file_requirements_format( | ||
| cli_runner: CliRunner, tmp_path: pathlib.Path | ||
| ) -> None: | ||
| """--output writes requirements pins to a file for 'requirements' format.""" | ||
| output_file = tmp_path / "requirements.txt" | ||
| result = _invoke_list_versions( | ||
| cli_runner, | ||
| extra_args=["--format", "requirements", "--output", str(output_file)], | ||
| ) | ||
| assert result.exit_code == 0 | ||
| assert output_file.exists() | ||
| content = output_file.read_text() | ||
| lines = [line for line in content.strip().split("\n") if line.strip()] | ||
| assert "test-pkg==1.2.2" in lines | ||
| assert "test-pkg==1.3.2" in lines | ||
| assert "test-pkg==2.0.0" in lines | ||
|
|
||
|
|
||
| # --------------------------------------------------------------------------- | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Complete the stdout leak assertion for plain output.
The test misses
test-pkgin the “not in stdout” checks, so a partial stdout leak could still pass.Suggested patch
# stdout should be empty (no data printed to console) assert "test-other-pkg" not in result.stdout + assert "test-pkg" not in result.stdout assert "test-pkg-library" not in result.stdout📝 Committable suggestion
🤖 Prompt for AI Agents