mirror of
https://github.com/astral-sh/ruff.git
synced 2026-10-28 10:45:37 +08:00
Micha Reiser
a103832c28
## Summary This PR extends the PEP 723 configuration support to `ty.environment` settings. That is: * Scripts are checked with a separate virtual environment and search paths * Scripts can configure a different Python version * Scripts can configure a different Python platform Our long-term plan is to use uv to create the script's virtual environment. We don't do this in this PR. Instead, we: * Respect `VIRTUAL_ENV`, LSP fallback environment (the selected environment), global available Python installation. Unlike for projects, ty does not search for a local `.venv` folder * Unlike for projects, scripts default to an empty `environment.root` because scripts are considered to work in isolation. Users can customize `environment.root`. Out of scope for this PR but things we should look into next: * Report a diagnostic if a script's metadata fails to parse instead of falling back to the project's configuration. * Add support for the Python environment extension's file-specific virtual env (so that you can select a virtual env for a specific file) * Preserve source ranges for configuration options from script metadata (shouldn't be too hard but the PR is already large as it is) * Integrating with uv. I expect that this will require significant changes to the implementation to provide good UX, but I like to tackle problems one step at a time (it also makes it easier to explain why we changed something). * We currently don't watch for changes in script search paths. That means, results in the LSP or when using `ty check --watch` could get outdated ## Test Plan Testing: Added integration and language-server coverage and verified the relevant unit, CLI, server, and Markdown suites.
1177 lines
28 KiB
Rust
1177 lines
28 KiB
Rust
use insta_cmd::assert_cmd_snapshot;
|
|
|
|
use crate::CliTest;
|
|
|
|
#[test]
|
|
fn project_settings_and_overrides_do_not_apply() -> anyhow::Result<()> {
|
|
let case = CliTest::with_files([
|
|
(
|
|
"pyproject.toml",
|
|
r#"
|
|
[tool.ty.rules]
|
|
unresolved-reference = "ignore"
|
|
|
|
[[tool.ty.overrides]]
|
|
include = ["script.py"]
|
|
|
|
[tool.ty.overrides.rules]
|
|
unresolved-reference = "error"
|
|
"#,
|
|
),
|
|
(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# [tool.ty.rules]
|
|
# unresolved-reference = "warn"
|
|
# ///
|
|
|
|
print(missing)
|
|
"#,
|
|
),
|
|
])?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
warning[unresolved-reference]: Name `missing` used when not defined
|
|
--> script.py:7:7
|
|
|
|
|
7 | print(missing)
|
|
| ^^^^^^^
|
|
|
|
Found 1 diagnostic
|
|
|
|
----- stderr -----
|
|
");
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn verbose_rule_diagnostics_identify_script_metadata() -> anyhow::Result<()> {
|
|
let case = CliTest::with_file(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# [tool.ty.rules]
|
|
# unresolved-reference = "warn"
|
|
# ///
|
|
|
|
print(missing)
|
|
"#,
|
|
)?;
|
|
|
|
assert_cmd_snapshot!(case.command().arg("--verbose"), @"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
warning[unresolved-reference]: Name `missing` used when not defined
|
|
--> script.py:7:7
|
|
|
|
|
7 | print(missing)
|
|
| ^^^^^^^
|
|
info: rule `unresolved-reference` was selected in script metadata
|
|
|
|
Found 1 diagnostic
|
|
|
|
----- stderr -----
|
|
INFO Indexed 1 file(s) in 0.000s
|
|
");
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn python_version_diagnostics_identify_script_metadata() -> anyhow::Result<()> {
|
|
let case = CliTest::with_file(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# requires-python = ">=3.12"
|
|
# ///
|
|
|
|
PythonFinalizationError
|
|
"#,
|
|
)?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
error[unresolved-reference]: Name `PythonFinalizationError` used when not defined
|
|
--> script.py:6:1
|
|
|
|
|
6 | PythonFinalizationError
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^
|
|
info: `PythonFinalizationError` was added as a builtin in Python 3.13
|
|
info: Python 3.12 was assumed when resolving types because it was specified in script metadata
|
|
|
|
Found 1 diagnostic
|
|
|
|
----- stderr -----
|
|
");
|
|
assert_cmd_snapshot!(case.command().arg("--output-format").arg("concise"), @"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
script.py:6:1: error[unresolved-reference] Name `PythonFinalizationError` used when not defined
|
|
Found 1 diagnostic
|
|
|
|
----- stderr -----
|
|
");
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn metadata_without_tool_ty_uses_default_settings() -> anyhow::Result<()> {
|
|
let case = CliTest::with_files([
|
|
(
|
|
"pyproject.toml",
|
|
r#"
|
|
[tool.ty.rules]
|
|
all = "ignore"
|
|
|
|
[tool.ty.analysis]
|
|
respect-type-ignore-comments = false
|
|
"#,
|
|
),
|
|
(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# dependencies = []
|
|
# ///
|
|
|
|
value: int = "not an int"
|
|
suppressed: int = "not an int" # type: ignore
|
|
"#,
|
|
),
|
|
])?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @r#"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
error[invalid-assignment]: Object of type `Literal["not an int"]` is not assignable to `int`
|
|
--> script.py:6:14
|
|
|
|
|
6 | value: int = "not an int"
|
|
| --- ^^^^^^^^^^^^ Incompatible value of type `Literal["not an int"]`
|
|
| |
|
|
| Declared type
|
|
|
|
Found 1 diagnostic
|
|
|
|
----- stderr -----
|
|
"#);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn environment_options() -> anyhow::Result<()> {
|
|
let case = CliTest::with_file(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# requires-python = ">=3.13"
|
|
#
|
|
# [tool.ty.environment]
|
|
# python-version = "3.11"
|
|
# ///
|
|
|
|
import sys
|
|
from typing import reveal_type
|
|
|
|
reveal_type(sys.version_info[:2])
|
|
"#,
|
|
)?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
info[revealed-type]: Revealed type
|
|
--> script.py:12:13
|
|
|
|
|
12 | reveal_type(sys.version_info[:2])
|
|
| ^^^^^^^^^^^^^^^^^^^^ `tuple[Literal[3], Literal[11]]`
|
|
|
|
Found 1 diagnostic
|
|
|
|
----- stderr -----
|
|
");
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn inline_overrides_are_ignored() -> anyhow::Result<()> {
|
|
// TODO: Emit a diagnostic for options that are not allowed within scripts.
|
|
let case = CliTest::with_file(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# [tool.ty.rules]
|
|
# unresolved-reference = "warn"
|
|
#
|
|
# [[tool.ty.overrides]]
|
|
# include = ["script.py"]
|
|
#
|
|
# [tool.ty.overrides.rules]
|
|
# unresolved-reference = "ignore"
|
|
# ///
|
|
|
|
print(missing)
|
|
"#,
|
|
)?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
warning[unresolved-reference]: Name `missing` used when not defined
|
|
--> script.py:13:7
|
|
|
|
|
13 | print(missing)
|
|
| ^^^^^^^
|
|
|
|
Found 1 diagnostic
|
|
|
|
----- stderr -----
|
|
");
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn inline_terminal_settings_do_not_apply() -> anyhow::Result<()> {
|
|
// TODO: Either support (when calling `ty check <script>`), or raise a diagnostic that this option is not supported
|
|
let case = CliTest::with_file(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# [tool.ty.rules]
|
|
# unresolved-reference = "warn"
|
|
#
|
|
# [tool.ty.terminal]
|
|
# error-on-warning = false
|
|
# ///
|
|
|
|
print(missing)
|
|
"#,
|
|
)?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
warning[unresolved-reference]: Name `missing` used when not defined
|
|
--> script.py:10:7
|
|
|
|
|
10 | print(missing)
|
|
| ^^^^^^^
|
|
|
|
Found 1 diagnostic
|
|
|
|
----- stderr -----
|
|
");
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn inline_settings_override_user_configuration() -> anyhow::Result<()> {
|
|
let case = CliTest::with_file(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# [tool.ty.rules]
|
|
# unresolved-reference = "error"
|
|
#
|
|
# [tool.ty.analysis]
|
|
# respect-type-ignore-comments = false
|
|
# ///
|
|
|
|
print(missing) # type: ignore
|
|
"#,
|
|
)?;
|
|
case.write_file(
|
|
case.user_config_directory().join("ty/ty.toml"),
|
|
r#"
|
|
[rules]
|
|
unresolved-reference = "ignore"
|
|
|
|
[analysis]
|
|
respect-type-ignore-comments = true
|
|
"#,
|
|
)?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
error[unresolved-reference]: Name `missing` used when not defined
|
|
--> script.py:10:7
|
|
|
|
|
10 | print(missing) # type: ignore
|
|
| ^^^^^^^
|
|
|
|
Found 1 diagnostic
|
|
|
|
----- stderr -----
|
|
");
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn user_configuration_applies() -> anyhow::Result<()> {
|
|
let case = CliTest::with_file(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# dependencies = []
|
|
# ///
|
|
|
|
print(missing)
|
|
print(suppressed) # type: ignore
|
|
"#,
|
|
)?;
|
|
case.write_file(
|
|
case.user_config_directory().join("ty/ty.toml"),
|
|
r#"
|
|
[rules]
|
|
unresolved-reference = "warn"
|
|
|
|
[analysis]
|
|
respect-type-ignore-comments = false
|
|
"#,
|
|
)?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
warning[unresolved-reference]: Name `missing` used when not defined
|
|
--> script.py:6:7
|
|
|
|
|
6 | print(missing)
|
|
| ^^^^^^^
|
|
|
|
warning[unresolved-reference]: Name `suppressed` used when not defined
|
|
--> script.py:7:7
|
|
|
|
|
7 | print(suppressed) # type: ignore
|
|
| ^^^^^^^^^^
|
|
|
|
Found 2 diagnostics
|
|
|
|
----- stderr -----
|
|
");
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn cli_arguments_override_script_options() -> anyhow::Result<()> {
|
|
let case = CliTest::with_file(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# [tool.ty.rules]
|
|
# unresolved-reference = "ignore"
|
|
#
|
|
# [tool.ty.analysis]
|
|
# respect-type-ignore-comments = false
|
|
# ///
|
|
|
|
print(missing)
|
|
print(suppressed) # type: ignore
|
|
"#,
|
|
)?;
|
|
|
|
assert_cmd_snapshot!(
|
|
case.command()
|
|
.arg("--warn")
|
|
.arg("unresolved-reference")
|
|
.arg("--config")
|
|
.arg("analysis.respect-type-ignore-comments=true"),
|
|
@"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
warning[unresolved-reference]: Name `missing` used when not defined
|
|
--> script.py:10:7
|
|
|
|
|
10 | print(missing)
|
|
| ^^^^^^^
|
|
|
|
Found 1 diagnostic
|
|
|
|
----- stderr -----
|
|
"
|
|
);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn explicit_config_replaces_inline_metadata() -> anyhow::Result<()> {
|
|
let case = CliTest::with_files([
|
|
(
|
|
"explicit.toml",
|
|
r#"
|
|
[rules]
|
|
unresolved-reference = "warn"
|
|
|
|
[analysis]
|
|
respect-type-ignore-comments = true
|
|
"#,
|
|
),
|
|
(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# [tool.ty.rules]
|
|
# unresolved-reference = "ignore"
|
|
#
|
|
# [tool.ty.analysis]
|
|
# respect-type-ignore-comments = false
|
|
# ///
|
|
|
|
print(missing)
|
|
print(suppressed) # type: ignore
|
|
"#,
|
|
),
|
|
])?;
|
|
|
|
assert_cmd_snapshot!(
|
|
case.command().arg("--config-file").arg("explicit.toml"),
|
|
@"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
warning[unresolved-reference]: Name `missing` used when not defined
|
|
--> script.py:10:7
|
|
|
|
|
10 | print(missing)
|
|
| ^^^^^^^
|
|
|
|
Found 1 diagnostic
|
|
|
|
----- stderr -----
|
|
"
|
|
);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn explicit_config_replaces_the_script_environment() -> anyhow::Result<()> {
|
|
let case = CliTest::with_files([
|
|
(
|
|
"explicit.toml",
|
|
r#"
|
|
[environment]
|
|
python-version = "3.12"
|
|
python-platform = "linux"
|
|
"#,
|
|
),
|
|
(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# requires-python = ">=3.13"
|
|
# [tool.ty.environment]
|
|
# python-platform = "win32"
|
|
# ///
|
|
|
|
import sys
|
|
from typing import reveal_type
|
|
|
|
reveal_type(sys.version_info[:2])
|
|
reveal_type(sys.platform)
|
|
"#,
|
|
),
|
|
])?;
|
|
|
|
assert_cmd_snapshot!(case.command().arg("--config-file").arg("explicit.toml"), @r#"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
info[revealed-type]: Revealed type
|
|
--> script.py:11:13
|
|
|
|
|
11 | reveal_type(sys.version_info[:2])
|
|
| ^^^^^^^^^^^^^^^^^^^^ `tuple[Literal[3], Literal[12]]`
|
|
|
|
info[revealed-type]: Revealed type
|
|
--> script.py:12:13
|
|
|
|
|
12 | reveal_type(sys.platform)
|
|
| ^^^^^^^^^^^^ `Literal["linux"]`
|
|
|
|
Found 2 diagnostics
|
|
|
|
----- stderr -----
|
|
"#);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn cli_arguments_override_script_environment() -> anyhow::Result<()> {
|
|
let case = CliTest::with_file(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# requires-python = ">=3.13"
|
|
# [tool.ty.environment]
|
|
# python-platform = "win32"
|
|
# ///
|
|
|
|
import sys
|
|
from typing import reveal_type
|
|
|
|
reveal_type(sys.version_info[:2])
|
|
reveal_type(sys.platform)
|
|
"#,
|
|
)?;
|
|
|
|
assert_cmd_snapshot!(
|
|
case.command()
|
|
.arg("--python-version")
|
|
.arg("3.12")
|
|
.arg("--python-platform")
|
|
.arg("linux"),
|
|
@r#"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
info[revealed-type]: Revealed type
|
|
--> script.py:11:13
|
|
|
|
|
11 | reveal_type(sys.version_info[:2])
|
|
| ^^^^^^^^^^^^^^^^^^^^ `tuple[Literal[3], Literal[12]]`
|
|
|
|
info[revealed-type]: Revealed type
|
|
--> script.py:12:13
|
|
|
|
|
12 | reveal_type(sys.platform)
|
|
| ^^^^^^^^^^^^ `Literal["linux"]`
|
|
|
|
Found 2 diagnostics
|
|
|
|
----- stderr -----
|
|
"#
|
|
);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn script_version_and_platform_are_isolated_from_project_configuration() -> anyhow::Result<()> {
|
|
let case = CliTest::with_files([
|
|
(
|
|
"pyproject.toml",
|
|
r#"
|
|
[tool.ty.environment]
|
|
python-version = "3.12"
|
|
python-platform = "linux"
|
|
"#,
|
|
),
|
|
(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# requires-python = ">=3.13"
|
|
# [tool.ty.environment]
|
|
# python-version = "3.11"
|
|
# python-platform = "win32"
|
|
# ///
|
|
|
|
import sys
|
|
from typing import reveal_type
|
|
|
|
reveal_type(sys.version_info[:2])
|
|
reveal_type(sys.platform)
|
|
"#,
|
|
),
|
|
])?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @r#"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
info[revealed-type]: Revealed type
|
|
--> script.py:12:13
|
|
|
|
|
12 | reveal_type(sys.version_info[:2])
|
|
| ^^^^^^^^^^^^^^^^^^^^ `tuple[Literal[3], Literal[11]]`
|
|
|
|
info[revealed-type]: Revealed type
|
|
--> script.py:13:13
|
|
|
|
|
13 | reveal_type(sys.platform)
|
|
| ^^^^^^^^^^^^ `Literal["win32"]`
|
|
|
|
Found 2 diagnostics
|
|
|
|
----- stderr -----
|
|
"#);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn python_requirement_overrides_user_configuration() -> anyhow::Result<()> {
|
|
let case = CliTest::with_file(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# requires-python = ">=3.13"
|
|
# ///
|
|
|
|
import sys
|
|
from typing import reveal_type
|
|
|
|
reveal_type(sys.version_info[:2])
|
|
"#,
|
|
)?;
|
|
case.write_file(
|
|
case.user_config_directory().join("ty/ty.toml"),
|
|
r#"
|
|
[environment]
|
|
python-version = "3.12"
|
|
"#,
|
|
)?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
info[revealed-type]: Revealed type
|
|
--> script.py:9:13
|
|
|
|
|
9 | reveal_type(sys.version_info[:2])
|
|
| ^^^^^^^^^^^^^^^^^^^^ `tuple[Literal[3], Literal[13]]`
|
|
|
|
Found 1 diagnostic
|
|
|
|
----- stderr -----
|
|
");
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn scripts_have_no_implicit_first_party_roots() -> anyhow::Result<()> {
|
|
let case = CliTest::with_files([
|
|
("shared.py", "value = 1\n"),
|
|
("src/layout_dependency.py", "value = 1\n"),
|
|
("scripts/local_dependency.py", "value = 1\n"),
|
|
(
|
|
"scripts/script.py",
|
|
r#"
|
|
# /// script
|
|
# dependencies = []
|
|
# ///
|
|
|
|
from layout_dependency import value as layout_value
|
|
from local_dependency import value as local_value
|
|
from shared import value
|
|
"#,
|
|
),
|
|
])?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
error[unresolved-import]: Cannot resolve imported module `layout_dependency`
|
|
--> scripts/script.py:6:6
|
|
|
|
|
6 | from layout_dependency import value as layout_value
|
|
| ^^^^^^^^^^^^^^^^^
|
|
info: Searched in the following paths during module resolution:
|
|
info: 1. vendored://stdlib (stdlib typeshed stubs vendored by ty)
|
|
info: make sure your Python environment is properly configured: https://docs.astral.sh/ty/modules/#python-environment
|
|
|
|
error[unresolved-import]: Cannot resolve imported module `local_dependency`
|
|
--> scripts/script.py:7:6
|
|
|
|
|
7 | from local_dependency import value as local_value
|
|
| ^^^^^^^^^^^^^^^^
|
|
info: Searched in the following paths during module resolution:
|
|
info: 1. vendored://stdlib (stdlib typeshed stubs vendored by ty)
|
|
info: make sure your Python environment is properly configured: https://docs.astral.sh/ty/modules/#python-environment
|
|
|
|
error[unresolved-import]: Cannot resolve imported module `shared`
|
|
--> scripts/script.py:8:6
|
|
|
|
|
8 | from shared import value
|
|
| ^^^^^^
|
|
info: Searched in the following paths during module resolution:
|
|
info: 1. vendored://stdlib (stdlib typeshed stubs vendored by ty)
|
|
info: make sure your Python environment is properly configured: https://docs.astral.sh/ty/modules/#python-environment
|
|
|
|
Found 3 diagnostics
|
|
|
|
----- stderr -----
|
|
");
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn configured_source_roots_and_extra_paths_are_relative_to_the_script() -> anyhow::Result<()> {
|
|
let case = CliTest::with_files([
|
|
("scripts/source/first_party.py", "value = 1\n"),
|
|
("scripts/extra/dependency.py", "value = 1\n"),
|
|
(
|
|
"scripts/script.py",
|
|
r#"
|
|
# /// script
|
|
# [tool.ty.environment]
|
|
# root = ["./source"]
|
|
# extra-paths = ["./extra"]
|
|
# ///
|
|
|
|
from dependency import value as dependency
|
|
from first_party import value as first_party
|
|
"#,
|
|
),
|
|
])?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
All checks passed!
|
|
|
|
----- stderr -----
|
|
");
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn project_search_paths_do_not_apply_to_scripts() -> anyhow::Result<()> {
|
|
let case = CliTest::with_files([
|
|
(
|
|
"pyproject.toml",
|
|
r#"
|
|
[tool.ty.environment]
|
|
root = ["./project-source"]
|
|
extra-paths = ["./project-extra"]
|
|
"#,
|
|
),
|
|
("project-source/project_only.py", "value = 1\n"),
|
|
("project-extra/extra_only.py", "value = 1\n"),
|
|
(
|
|
"ordinary.py",
|
|
"from extra_only import value as extra\nfrom project_only import value as project\n",
|
|
),
|
|
(
|
|
"scripts/script.py",
|
|
r#"
|
|
# /// script
|
|
# dependencies = []
|
|
# ///
|
|
|
|
from extra_only import value as extra
|
|
from project_only import value as project
|
|
"#,
|
|
),
|
|
])?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
error[unresolved-import]: Cannot resolve imported module `extra_only`
|
|
--> scripts/script.py:6:6
|
|
|
|
|
6 | from extra_only import value as extra
|
|
| ^^^^^^^^^^
|
|
info: Searched in the following paths during module resolution:
|
|
info: 1. vendored://stdlib (stdlib typeshed stubs vendored by ty)
|
|
info: make sure your Python environment is properly configured: https://docs.astral.sh/ty/modules/#python-environment
|
|
|
|
error[unresolved-import]: Cannot resolve imported module `project_only`
|
|
--> scripts/script.py:7:6
|
|
|
|
|
7 | from project_only import value as project
|
|
| ^^^^^^^^^^^^
|
|
info: Searched in the following paths during module resolution:
|
|
info: 1. vendored://stdlib (stdlib typeshed stubs vendored by ty)
|
|
info: make sure your Python environment is properly configured: https://docs.astral.sh/ty/modules/#python-environment
|
|
|
|
Found 2 diagnostics
|
|
|
|
----- stderr -----
|
|
");
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn shared_imports_use_each_scripts_platform() -> anyhow::Result<()> {
|
|
let case = CliTest::with_files([
|
|
(
|
|
"shared.py",
|
|
r#"
|
|
import sys
|
|
|
|
if sys.platform == "win32":
|
|
value = "windows"
|
|
else:
|
|
value = "other"
|
|
"#,
|
|
),
|
|
(
|
|
"windows.py",
|
|
r#"
|
|
# /// script
|
|
# [tool.ty.environment]
|
|
# extra-paths = ["."]
|
|
# python-platform = "win32"
|
|
# ///
|
|
|
|
from shared import value
|
|
from typing import reveal_type
|
|
|
|
reveal_type(value)
|
|
"#,
|
|
),
|
|
(
|
|
"linux.py",
|
|
r#"
|
|
# /// script
|
|
# [tool.ty.environment]
|
|
# extra-paths = ["."]
|
|
# python-platform = "linux"
|
|
# ///
|
|
|
|
from shared import value
|
|
from typing import reveal_type
|
|
|
|
reveal_type(value)
|
|
"#,
|
|
),
|
|
])?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @r#"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
info[revealed-type]: Revealed type
|
|
--> linux.py:11:13
|
|
|
|
|
11 | reveal_type(value)
|
|
| ^^^^^ `Literal["other"]`
|
|
|
|
info[revealed-type]: Revealed type
|
|
--> windows.py:11:13
|
|
|
|
|
11 | reveal_type(value)
|
|
| ^^^^^ `Literal["windows"]`
|
|
|
|
Found 2 diagnostics
|
|
|
|
----- stderr -----
|
|
"#);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn inherited_file_settings_are_relative_to_the_script() -> anyhow::Result<()> {
|
|
let case = CliTest::with_files([
|
|
("user-extra/project_dependency.py", "value = 1\n"),
|
|
("scripts/user-extra/user_dependency.py", "value = 1\n"),
|
|
("cli-extra/cli_dependency.py", "value = 1\n"),
|
|
(
|
|
"scripts/script.py",
|
|
r#"
|
|
# /// script
|
|
# dependencies = []
|
|
# ///
|
|
|
|
from user_dependency import value as user_value
|
|
from cli_dependency import value as cli_value
|
|
"#,
|
|
),
|
|
])?;
|
|
case.write_file(
|
|
case.user_config_directory().join("ty/ty.toml"),
|
|
r#"
|
|
[environment]
|
|
extra-paths = ["./user-extra"]
|
|
"#,
|
|
)?;
|
|
|
|
assert_cmd_snapshot!(case.command().arg("--extra-search-path").arg("./cli-extra"), @"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
All checks passed!
|
|
|
|
----- stderr -----
|
|
");
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn scripts_do_not_use_an_inactive_project_environment() -> anyhow::Result<()> {
|
|
let dependency = if cfg!(windows) {
|
|
".venv/Lib/site-packages/project_dependency.py"
|
|
} else {
|
|
".venv/lib/python3.13/site-packages/project_dependency.py"
|
|
};
|
|
|
|
let case = CliTest::with_files([
|
|
(".venv/pyvenv.cfg", "home = ./\nversion = 3.13\n"),
|
|
(dependency, "value = 1\n"),
|
|
(
|
|
"scripts/script.py",
|
|
r#"
|
|
# /// script
|
|
# dependencies = []
|
|
# ///
|
|
|
|
from project_dependency import value
|
|
"#,
|
|
),
|
|
])?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
error[unresolved-import]: Cannot resolve imported module `project_dependency`
|
|
--> scripts/script.py:6:6
|
|
|
|
|
6 | from project_dependency import value
|
|
| ^^^^^^^^^^^^^^^^^^
|
|
info: Searched in the following paths during module resolution:
|
|
info: 1. vendored://stdlib (stdlib typeshed stubs vendored by ty)
|
|
info: make sure your Python environment is properly configured: https://docs.astral.sh/ty/modules/#python-environment
|
|
|
|
Found 1 diagnostic
|
|
|
|
----- stderr -----
|
|
");
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn scripts_use_an_activated_virtual_environment() -> anyhow::Result<()> {
|
|
let dependency = if cfg!(windows) {
|
|
".venv/Lib/site-packages/project_dependency.py"
|
|
} else {
|
|
".venv/lib/python3.13/site-packages/project_dependency.py"
|
|
};
|
|
|
|
let case = CliTest::with_files([
|
|
(".venv/pyvenv.cfg", "home = ./\nversion = 3.13\n"),
|
|
(dependency, "value = 1\n"),
|
|
(
|
|
"scripts/script.py",
|
|
r#"
|
|
# /// script
|
|
# dependencies = []
|
|
# ///
|
|
|
|
from project_dependency import value
|
|
"#,
|
|
),
|
|
])?;
|
|
|
|
assert_cmd_snapshot!(case.command().env("VIRTUAL_ENV", case.root().join(".venv")), @"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
All checks passed!
|
|
|
|
----- stderr -----
|
|
");
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn invalid_python_requirement_falls_back_to_project_configuration() -> anyhow::Result<()> {
|
|
let case = CliTest::with_files([
|
|
(
|
|
"pyproject.toml",
|
|
r#"
|
|
[tool.ty.environment]
|
|
python-platform = "linux"
|
|
|
|
[tool.ty.rules]
|
|
unresolved-reference = "error"
|
|
"#,
|
|
),
|
|
(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# requires-python = "<3.12"
|
|
# [tool.ty.environment]
|
|
# python-platform = "win32"
|
|
# [tool.ty.rules]
|
|
# unresolved-reference = "warn"
|
|
# ///
|
|
|
|
import sys
|
|
from typing import reveal_type
|
|
|
|
reveal_type(sys.platform)
|
|
print(missing)
|
|
"#,
|
|
),
|
|
])?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @r#"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
info[revealed-type]: Revealed type
|
|
--> script.py:13:13
|
|
|
|
|
13 | reveal_type(sys.platform)
|
|
| ^^^^^^^^^^^^ `Literal["linux"]`
|
|
|
|
error[unresolved-reference]: Name `missing` used when not defined
|
|
--> script.py:14:7
|
|
|
|
|
14 | print(missing)
|
|
| ^^^^^^^
|
|
|
|
Found 2 diagnostics
|
|
|
|
----- stderr -----
|
|
"#);
|
|
assert_cmd_snapshot!(case.command().arg("--output-format").arg("concise"), @r#"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
script.py:13:13: info[revealed-type] Revealed type: `Literal["linux"]`
|
|
script.py:14:7: error[unresolved-reference] Name `missing` used when not defined
|
|
Found 2 diagnostics
|
|
|
|
----- stderr -----
|
|
"#);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn invalid_script_settings_fall_back_to_project_configuration() -> anyhow::Result<()> {
|
|
// FIXME: Scripts with invalid settings should not be checked.
|
|
let case = CliTest::with_files([
|
|
(
|
|
"pyproject.toml",
|
|
r#"
|
|
[tool.ty.environment]
|
|
python-platform = "linux"
|
|
"#,
|
|
),
|
|
(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# [tool.ty.src]
|
|
# include = ["src/**test/"]
|
|
# [tool.ty.environment]
|
|
# python-platform = "win32"
|
|
# ///
|
|
|
|
import sys
|
|
from typing import reveal_type
|
|
|
|
reveal_type(sys.platform)
|
|
"#,
|
|
),
|
|
])?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @r#"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
info[revealed-type]: Revealed type
|
|
--> script.py:12:13
|
|
|
|
|
12 | reveal_type(sys.platform)
|
|
| ^^^^^^^^^^^^ `Literal["linux"]`
|
|
|
|
Found 1 diagnostic
|
|
|
|
----- stderr -----
|
|
"#);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn invalid_script_environment_falls_back_to_project_configuration() -> anyhow::Result<()> {
|
|
// FIXME: Scripts with invalid environments should not be checked.
|
|
let case = CliTest::with_files([
|
|
(
|
|
"pyproject.toml",
|
|
r#"
|
|
[tool.ty.environment]
|
|
python-version = "3.13"
|
|
python-platform = "linux"
|
|
"#,
|
|
),
|
|
(
|
|
"script.py",
|
|
r#"
|
|
# /// script
|
|
# [tool.ty.environment]
|
|
# python = "./missing-environment"
|
|
# python-version = "3.12"
|
|
# python-platform = "win32"
|
|
# ///
|
|
|
|
import sys
|
|
from typing import reveal_type
|
|
|
|
reveal_type(sys.version_info[:2])
|
|
reveal_type(sys.platform)
|
|
"#,
|
|
),
|
|
])?;
|
|
|
|
assert_cmd_snapshot!(case.command(), @r#"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
info[revealed-type]: Revealed type
|
|
--> script.py:12:13
|
|
|
|
|
12 | reveal_type(sys.version_info[:2])
|
|
| ^^^^^^^^^^^^^^^^^^^^ `tuple[Literal[3], Literal[13]]`
|
|
|
|
info[revealed-type]: Revealed type
|
|
--> script.py:13:13
|
|
|
|
|
13 | reveal_type(sys.platform)
|
|
| ^^^^^^^^^^^^ `Literal["linux"]`
|
|
|
|
Found 2 diagnostics
|
|
|
|
----- stderr -----
|
|
"#);
|
|
|
|
Ok(())
|
|
}
|