Python
/
ruff
mirror of https://github.com/astral-sh/ruff
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[ty] Make Python-version subdiagnostics less verbose (#21849)

This commit is contained in:
Alex Waygood 2025-12-08 15:58:23 +00:00 committed by GitHub
parent 3981a23ee9
commit 0ccd84136a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 17 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
crates/ty/tests/cli/python_environment.rs
View File

@ -43,7 +43,7 @@ fn config_override_python_version() -> anyhow::Result<()> {
| |
2 | [tool.ty.environment] 2 | [tool.ty.environment]
3 | python-version = "3.11" 3 | python-version = "3.11"
| ^^^^^^ Python 3.11 assumed due to this configuration setting | ^^^^^^ Python version configuration
| |
info: rule `unresolved-attribute` is enabled by default info: rule `unresolved-attribute` is enabled by default
@ -143,7 +143,7 @@ fn config_file_annotation_showing_where_python_version_set_typing_error() -> any
), ),
])?; ])?;
assert_cmd_snapshot!(case.command(), @r###" assert_cmd_snapshot!(case.command(), @r#"
success: false success: false
exit_code: 1 exit_code: 1
----- stdout ----- ----- stdout -----
@ -159,14 +159,14 @@ fn config_file_annotation_showing_where_python_version_set_typing_error() -> any
| |
2 | [tool.ty.environment] 2 | [tool.ty.environment]
3 | python-version = "3.8" 3 | python-version = "3.8"
| ^^^^^ Python 3.8 assumed due to this configuration setting | ^^^^^ Python version configuration
| |
info: rule `unresolved-reference` is enabled by default info: rule `unresolved-reference` is enabled by default
Found 1 diagnostic Found 1 diagnostic
----- stderr ----- ----- stderr -----
"###); "#);
assert_cmd_snapshot!(case.command().arg("--python-version=3.9"), @r###" assert_cmd_snapshot!(case.command().arg("--python-version=3.9"), @r###"
success: false success: false
@ -772,7 +772,7 @@ fn pyvenv_cfg_file_annotation_showing_where_python_version_set() -> anyhow::Resu
("test.py", "aiter"), ("test.py", "aiter"),
])?; ])?;
assert_cmd_snapshot!(case.command(), @r###" assert_cmd_snapshot!(case.command(), @r"
success: false success: false
exit_code: 1 exit_code: 1
----- stdout ----- ----- stdout -----
@ -787,7 +787,7 @@ fn pyvenv_cfg_file_annotation_showing_where_python_version_set() -> anyhow::Resu
--> venv/pyvenv.cfg:2:11 --> venv/pyvenv.cfg:2:11
| |
2 | version = 3.8 2 | version = 3.8
| ^^^ Python version inferred from virtual environment metadata file | ^^^ Virtual environment metadata
3 | home = foo/bar/bin 3 | home = foo/bar/bin
| |
info: No Python version was specified on the command line or in a configuration file info: No Python version was specified on the command line or in a configuration file
@ -796,7 +796,7 @@ fn pyvenv_cfg_file_annotation_showing_where_python_version_set() -> anyhow::Resu
Found 1 diagnostic Found 1 diagnostic
----- stderr ----- ----- stderr -----
"###); ");
Ok(()) Ok(())
} }
@ -831,7 +831,7 @@ fn pyvenv_cfg_file_annotation_no_trailing_newline() -> anyhow::Result<()> {
("test.py", "aiter"), ("test.py", "aiter"),
])?; ])?;
assert_cmd_snapshot!(case.command(), @r###" assert_cmd_snapshot!(case.command(), @r"
success: false success: false
exit_code: 1 exit_code: 1
----- stdout ----- ----- stdout -----
@ -846,7 +846,7 @@ fn pyvenv_cfg_file_annotation_no_trailing_newline() -> anyhow::Result<()> {
--> venv/pyvenv.cfg:4:23 --> venv/pyvenv.cfg:4:23
| |
4 | version = 3.8 4 | version = 3.8
| ^^^ Python version inferred from virtual environment metadata file | ^^^ Virtual environment metadata
| |
info: No Python version was specified on the command line or in a configuration file info: No Python version was specified on the command line or in a configuration file
info: rule `unresolved-reference` is enabled by default info: rule `unresolved-reference` is enabled by default
@ -854,7 +854,7 @@ fn pyvenv_cfg_file_annotation_no_trailing_newline() -> anyhow::Result<()> {
Found 1 diagnostic Found 1 diagnostic
----- stderr ----- ----- stderr -----
"###); ");
Ok(()) Ok(())
} }
@ -898,7 +898,7 @@ fn config_file_annotation_showing_where_python_version_set_syntax_error() -> any
| |
2 | [project] 2 | [project]
3 | requires-python = ">=3.8" 3 | requires-python = ">=3.8"
| ^^^^^^^ Python 3.8 assumed due to this configuration setting | ^^^^^^^ Python version configuration
| |
Found 1 diagnostic Found 1 diagnostic
@ -1206,7 +1206,7 @@ fn defaults_to_a_new_python_version() -> anyhow::Result<()> {
| |
2 | [environment] 2 | [environment]
3 | python-version = "3.10" 3 | python-version = "3.10"
| ^^^^^^ Python 3.10 assumed due to this configuration setting | ^^^^^^ Python version configuration
4 | python-platform = "linux" 4 | python-platform = "linux"
| |
info: rule `unresolved-attribute` is enabled by default info: rule `unresolved-attribute` is enabled by default
@ -1225,7 +1225,7 @@ fn defaults_to_a_new_python_version() -> anyhow::Result<()> {
| |
2 | [environment] 2 | [environment]
3 | python-version = "3.10" 3 | python-version = "3.10"
| ^^^^^^ Python 3.10 assumed due to this configuration setting | ^^^^^^ Python version configuration
4 | python-platform = "linux" 4 | python-platform = "linux"
| |
info: rule `unresolved-import` is enabled by default info: rule `unresolved-import` is enabled by default

11
crates/ty_python_semantic/src/diagnostic.rs
View File

@ -58,9 +58,8 @@ pub fn add_inferred_python_version_hint_to_diagnostic(
SubDiagnosticSeverity::Info, SubDiagnosticSeverity::Info,
format_args!("Python {version} was assumed when {action}"), format_args!("Python {version} was assumed when {action}"),
); );
sub_diagnostic.annotate(Annotation::primary(span).message(format_args!( sub_diagnostic
"Python {version} assumed due to this configuration setting" .annotate(Annotation::primary(span).message("Python version configuration"));
)));
diagnostic.sub(sub_diagnostic); diagnostic.sub(sub_diagnostic);
} else { } else {
diagnostic.info(format_args!( diagnostic.info(format_args!(
@ -76,10 +75,8 @@ pub fn add_inferred_python_version_hint_to_diagnostic(
"Python {version} was assumed when {action} because of your virtual environment" "Python {version} was assumed when {action} because of your virtual environment"
), ),
); );
sub_diagnostic.annotate( sub_diagnostic
Annotation::primary(span) .annotate(Annotation::primary(span).message("Virtual environment metadata"));
.message("Python version inferred from virtual environment metadata file"),
);
// TODO: it would also be nice to tell them how we resolved their virtual environment... // TODO: it would also be nice to tell them how we resolved their virtual environment...
diagnostic.sub(sub_diagnostic); diagnostic.sub(sub_diagnostic);
} else { } else {